Console System API

Role

Other API in Package

Console

Console Webservice

Internal Console

Method Summary
ProfileInfo getProfile()

Returns profile associated with this role.

String getRole()

Returns the role name.

String getStatus()

Returns the role status.

boolean isActive()

Returns true if this role is the active role for the user.

boolean isOwner()

Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal).

boolean isRegistered()

Returns true if the user associated with the role is a registered.

  revoke()

Removes the role from the associated user. You should not attempt to use this Role once it has been revoked.

  setActive(boolean active)

Sets this role to be the active role for the user.

  setStatus(String status)

Sets the role status.

String toString()

Returns a description of this object.

Method Detail


ProfileInfo getProfile()

Returns profile associated with this role.

Returns:  ProfileInfo

Since: 07-06-2009

top

String getRole()

Returns the role name.

Returns:  String

Since: 05-18-2011

top

String getStatus()

Returns the role status.

Returns:  String

Since: 05-18-2011

top

boolean isActive()

Returns true if this role is the active role for the user.

Returns:  boolean

Since: 05-18-2011

top

boolean isOwner()

Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal).

Returns:  boolean

Since: 05-31-2007

top

boolean isRegistered()

Returns true if the user associated with the role is a registered.

Returns:  boolean

Since: 11-30-2007

top

revoke()

Removes the role from the associated user. You should not attempt to use this Role once it has been revoked.

Since: 05-18-2011

top

setActive(boolean active)

Sets this role to be the active role for the user.

Parameters:

  • boolean   active Required parameter.

Since: 05-18-2011

top

setStatus(String status)

Sets the role status.

Parameters:

  • String   status Maximum allowed size of parameter: 20

Since: 05-18-2011

top

String toString()

Returns a description of this object.

Returns:  String

Since: 06-14-2007

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM