|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
---|---|
java.lang.String[] |
categoriesAuthorizedFor()
Returns the categories the person is authorized for with basic or with administration rights. |
java.lang.String[] |
categoriesAuthorizedForAsAdmin()
Returns the categories the person is authorized for with administration rights. |
java.lang.String |
description()
Returns the description of the person. |
java.lang.String |
firstName()
Returns the first name of the person. |
boolean |
isAbsent()
Indicates whether the person is absent. |
boolean |
isAdminForCategory(java.lang.String category)
Indicates whether the person has administrator rights for the specified category. |
boolean |
isAdministrator()
Indicates whether the person is an administrator. |
boolean |
isAuthorizedForAllCategories()
Indicates whether the person is said to be authorized for all categories either with basic and/or administration rights. |
boolean |
isAuthorizedForAllCategoriesAsAdmin()
Indicates whether the person is said to be authorized for all categories as administrator. |
boolean |
isAuthorizedForAllPersons()
Indicates whether the person is authorized to see the items of all persons. |
boolean |
isAuthorizedForAuthorizationDefinition()
Indicates whether the person is authorized to define authorizations. |
boolean |
isAuthorizedForOperationAdministration()
Indicates whether the person is authorized for operational administrations. |
boolean |
isAuthorizedForProcessDefinition()
Indicates whether the person is authorized to define process models. |
boolean |
isAuthorizedForStaffDefinition()
Indicates whether the person is authorized to define persons. |
boolean |
isAuthorizedForTopologyDefinition()
Indicates whether the person is authorized to define topological data. |
boolean |
isComplete()
Indicates whether the complete person information is available. |
boolean |
isEmpty()
Indicates whether no person information is available. |
boolean |
isManager()
Indicates whether the person is a manager. |
boolean |
isResetAbsence()
Indicates whether the absence flag should be reset when the person logs on. |
java.lang.String |
lastName()
Returns the last name of the person. |
int |
level()
Returns the level of the person. |
java.lang.String |
manager()
Returns the user identification of the person's manager. |
java.lang.String |
middleName()
Returns the middle name of the person. |
java.lang.String[] |
namesOfManagedOrganizations()
Returns the names of organizations the person manages. |
java.lang.String[] |
namesOfRoles()
Returns the names of roles the person belongs to. |
java.lang.String[] |
namesOfRolesToCoordinate()
Returns the names of roles the person can coordinate. |
java.lang.String |
organizationName()
Returns the name of the organization the person belongs to. |
java.lang.String |
personID()
Returns the person ID of the person. |
java.lang.String[] |
personsAuthorizedFor()
Returns the persons for whom this person is authorized either explicitly or by being a substitute. |
java.lang.String[] |
personsAuthorizedForMe()
Returns the persons who are authorized for this person. |
java.lang.String[] |
personsToStandInFor()
Returns the persons for whom this person stands in. |
java.lang.String |
phone()
Returns the phone number of the person. |
void |
refresh()
This API call refreshes the person from the MQ Workflow execution server (action call). |
java.lang.String |
secondPhone()
Returns the alternate phone number of the person. |
void |
setAbsence(boolean value)
This API call sets the absence indication of the logged-on user to the specified value (action call). |
void |
setSubstitute(java.lang.String substitute)
This API call sets the substitute of the logged-on user (action call). |
java.lang.String |
substitute()
Returns the substitute of the person. |
java.lang.String |
systemName()
Returns the home system of the person. |
java.lang.String |
userID()
Returns the user identification of the person. |
Method Detail |
public boolean isEmpty() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isComplete() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] categoriesAuthorizedFor() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] categoriesAuthorizedForAsAdmin() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String description() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String firstName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAbsent() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAdministrator() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForAllCategories() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForAllCategoriesAsAdmin() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForAllPersons() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForAuthorizationDefinition() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForOperationAdministration() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForProcessDefinition() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForStaffDefinition() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAuthorizedForTopologyDefinition() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isManager() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isResetAbsence() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String lastName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public int level() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String manager() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String middleName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] namesOfManagedOrganizations() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] namesOfRoles() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] namesOfRolesToCoordinate() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String organizationName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String personID() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] personsAuthorizedFor() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] personsAuthorizedForMe() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String[] personsToStandInFor() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String phone() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String secondPhone() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String substitute() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String systemName() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public java.lang.String userID() throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public boolean isAdminForCategory(java.lang.String category) throws FmcException
FmcException
- thrown if an API error or a communication error occurred.public void refresh() throws FmcException
This API call refreshes the person from the MQ Workflow execution server (action call).
All information about the person, primary and secondary, is retrieved.
FmcException
- thrown if an API error or a communication error occurred.public void setAbsence(boolean value) throws FmcException
This API call sets the absence indication of the logged-on user to the specified value (action call).
When a person is absent and the staff resolution options specify 'assign substitute if user is absent' or 'prefer non-absent users', then an absent person does not participate in staff resolution, that is, this person does not get assigned any work items.
FmcException
- thrown if an API error or a communication error occurred.public void setSubstitute(java.lang.String substitute) throws FmcException
This API call sets the substitute of the logged-on user (action call).
The substitute must be a registered MQ Workflow user ID other than the logged-on user. If no substitute is provided, the substitute of the logged-on user is erased.
FmcException
- thrown if an API error or a communication error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |