com.ibm.workflow.api
Interface Person


public interface Person


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

isEmpty

public boolean isEmpty()
                throws FmcException
Indicates whether no person information is available.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isComplete

public boolean isComplete()
                   throws FmcException
Indicates whether the complete person information is available.

Throws:
FmcException - thrown if an API error or a communication error occurred.

categoriesAuthorizedFor

public java.lang.String[] categoriesAuthorizedFor()
                                           throws FmcException
Returns the categories the person is authorized for with basic or with administration rights. If the person is authorized for all categories as administrator, no category is returned here. If the person is authorized for all categories with basic rights, categories authorized with administration rights are returned here.

Throws:
FmcException - thrown if an API error or a communication error occurred.

categoriesAuthorizedForAsAdmin

public java.lang.String[] categoriesAuthorizedForAsAdmin()
                                                  throws FmcException
Returns the categories the person is authorized for with administration rights. If the person is authorized for all categories with administration rights, no category is returned here.

Throws:
FmcException - thrown if an API error or a communication error occurred.

description

public java.lang.String description()
                             throws FmcException
Returns the description of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

firstName

public java.lang.String firstName()
                           throws FmcException
Returns the first name of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAbsent

public boolean isAbsent()
                 throws FmcException
Indicates whether the person is absent.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAdministrator

public boolean isAdministrator()
                        throws FmcException
Indicates whether the person is an administrator.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForAllCategories

public boolean isAuthorizedForAllCategories()
                                     throws FmcException
Indicates whether the person is said to be authorized for all categories either with basic and/or administration rights.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForAllCategoriesAsAdmin

public boolean isAuthorizedForAllCategoriesAsAdmin()
                                            throws FmcException
Indicates whether the person is said to be authorized for all categories as administrator.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForAllPersons

public boolean isAuthorizedForAllPersons()
                                  throws FmcException
Indicates whether the person is authorized to see the items of all persons.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForAuthorizationDefinition

public boolean isAuthorizedForAuthorizationDefinition()
                                               throws FmcException
Indicates whether the person is authorized to define authorizations.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForOperationAdministration

public boolean isAuthorizedForOperationAdministration()
                                               throws FmcException
Indicates whether the person is authorized for operational administrations.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForProcessDefinition

public boolean isAuthorizedForProcessDefinition()
                                         throws FmcException
Indicates whether the person is authorized to define process models.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForStaffDefinition

public boolean isAuthorizedForStaffDefinition()
                                       throws FmcException
Indicates whether the person is authorized to define persons.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAuthorizedForTopologyDefinition

public boolean isAuthorizedForTopologyDefinition()
                                          throws FmcException
Indicates whether the person is authorized to define topological data.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isManager

public boolean isManager()
                  throws FmcException
Indicates whether the person is a manager.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isResetAbsence

public boolean isResetAbsence()
                       throws FmcException
Indicates whether the absence flag should be reset when the person logs on.

Throws:
FmcException - thrown if an API error or a communication error occurred.

lastName

public java.lang.String lastName()
                          throws FmcException
Returns the last name of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

level

public int level()
          throws FmcException
Returns the level of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

manager

public java.lang.String manager()
                         throws FmcException
Returns the user identification of the person's manager.

Throws:
FmcException - thrown if an API error or a communication error occurred.

middleName

public java.lang.String middleName()
                            throws FmcException
Returns the middle name of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

namesOfManagedOrganizations

public java.lang.String[] namesOfManagedOrganizations()
                                               throws FmcException
Returns the names of organizations the person manages.

Throws:
FmcException - thrown if an API error or a communication error occurred.

namesOfRoles

public java.lang.String[] namesOfRoles()
                                throws FmcException
Returns the names of roles the person belongs to.

Throws:
FmcException - thrown if an API error or a communication error occurred.

namesOfRolesToCoordinate

public java.lang.String[] namesOfRolesToCoordinate()
                                            throws FmcException
Returns the names of roles the person can coordinate.

Throws:
FmcException - thrown if an API error or a communication error occurred.

organizationName

public java.lang.String organizationName()
                                  throws FmcException
Returns the name of the organization the person belongs to.

Throws:
FmcException - thrown if an API error or a communication error occurred.

personID

public java.lang.String personID()
                          throws FmcException
Returns the person ID of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

personsAuthorizedFor

public java.lang.String[] personsAuthorizedFor()
                                        throws FmcException
Returns the persons for whom this person is authorized either explicitly or by being a substitute. If the person is authorized for all other persons, then no person is returned here.

Throws:
FmcException - thrown if an API error or a communication error occurred.

personsAuthorizedForMe

public java.lang.String[] personsAuthorizedForMe()
                                          throws FmcException
Returns the persons who are authorized for this person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

personsToStandInFor

public java.lang.String[] personsToStandInFor()
                                       throws FmcException
Returns the persons for whom this person stands in.

Throws:
FmcException - thrown if an API error or a communication error occurred.

phone

public java.lang.String phone()
                       throws FmcException
Returns the phone number of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

secondPhone

public java.lang.String secondPhone()
                             throws FmcException
Returns the alternate phone number of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

substitute

public java.lang.String substitute()
                            throws FmcException
Returns the substitute of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

systemName

public java.lang.String systemName()
                            throws FmcException
Returns the home system of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

userID

public java.lang.String userID()
                        throws FmcException
Returns the user identification of the person.

Throws:
FmcException - thrown if an API error or a communication error occurred.

isAdminForCategory

public boolean isAdminForCategory(java.lang.String category)
                           throws FmcException
Indicates whether the person has administrator rights for the specified category. Returns false if the category does not exist. If the person is authorized for all categories as administrator, then true is returned independent of the category existence.

Throws:
FmcException - thrown if an API error or a communication error occurred.

refresh

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.

Throws:
FmcException - thrown if an API error or a communication error occurred.

setAbsence

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.

Throws:
FmcException - thrown if an API error or a communication error occurred.

setSubstitute

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.

Note:
Changing the substitute can result in changes of persons who are authorized to access the (work) items of the logged-on user. You must refresh the person object to read the updated definitions.
Throws:
FmcException - thrown if an API error or a communication error occurred.


© Copyright IBM Corporation 1999, 2007. All Rights Reserved.