All Packages Class Hierarchy This Package Previous Next Index
Interface com.ibm.workflow.api.Person
- public interface Person
- Version:
- 3.2.0.2
-
categoriesAuthorizedFor()
- Returns the categories
the person is authorized for with basic or with administration rights.
-
categoriesAuthorizedForAsAdmin()
- Returns the
categories the person is authorized for with administration rights.
-
description()
- Returns the description of the
person.
-
firstName()
- Returns the first name of the
person.
-
isAbsent()
- Indicates whether the person is
absent.
-
isAdminForCategory(String)
- Indicates whether the
person has administrator rights for the specified category.
-
isAdministrator()
- Indicates whether the person
is an administrator.
-
isAuthorizedForAllCategories()
- Indicates whether
the person is said to be authorized for all categories either with basic
and/or administration rights.
-
isAuthorizedForAllCategoriesAsAdmin()
- Indicates
whether the person is said to be authorized for all categories as
administrator.
-
isAuthorizedForAllPersons()
- Indicates whether
the person is authorized to see the items of all persons.
-
isAuthorizedForAuthorizationDefinition()
- Indicates
whether the person is authorized to define authorizations.
-
isAuthorizedForOperationAdministration()
- Indicates
whether the person is authorized for operational administrations.
-
isAuthorizedForProcessDefinition()
- Indicates
whether the person is authorized to define process models.
-
isAuthorizedForStaffDefinition()
- Indicates
whether the person is authorized to define persons.
-
isAuthorizedForTopologyDefinition()
- Indicates
whether the person is authorized to define topological data.
-
isComplete()
- Indicates whether the complete
person information is available.
-
isEmpty()
- Indicates whether no person
information is available.
-
isManager()
- Indicates whether the person is a
manager.
-
isResetAbsence()
- Indicates whether the absence
flag should be reset when the person logs on.
-
lastName()
- Returns the last name of the
person.
-
level()
- Returns the level of the person.
-
manager()
- Returns the user identification of the
person's manager.
-
middleName()
- Returns the middle name of the
person.
-
namesOfManagedOrganizations()
- Returns the names
of organizations the person manages.
-
namesOfRoles()
- Returns the names of roles the
person belongs to.
-
namesOfRolesToCoordinate()
- Returns the names of
roles the person can coordinate.
-
organizationName()
- Returns the name of the
organization the person belongs to.
-
personID()
- Returns the person ID of the
person.
-
personsAuthorizedFor()
- Returns the persons for
whom this person is authorized either explicitly or by being a
substitute.
-
personsAuthorizedForMe()
- Returns the persons who
are authorized for this person.
-
personsToStandInFor()
- Returns the persons for
whom this person stands in.
-
phone()
- Returns the phone number of the
person.
-
refresh()
-
This function/method refreshes the person from the MQ Workflow execution
server (action call).
-
secondPhone()
- Returns the alternate phone number
of the person.
-
setAbsence(boolean)
-
This function/method sets the absence indication of the logged-on user to
the specified value (action call).
-
setSubstitute(String)
-
This function/method sets the substitute of the logged-on user (action
call).
-
substitute()
- Returns the substitute of the
person.
-
systemName()
- Returns the home system of the
person.
-
userID()
- Returns the user identification of the
person.
isEmpty
public abstract 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 abstract 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 abstract 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 abstract 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 abstract String description() throws FmcException
- Returns the description of the
person.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
firstName
public abstract 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 abstract boolean isAbsent() throws FmcException
- Indicates whether the person is
absent.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
isAdministrator
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract int level() throws FmcException
- Returns the level of the person.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
manager
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String substitute() throws FmcException
- Returns the substitute of the
person.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
systemName
public abstract 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 abstract 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 abstract boolean isAdminForCategory(String category) throws FmcException
- Indicates whether the
person has administrator rights for the specified category. Returns
false if the category does not exist.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
refresh
public abstract void refresh() throws FmcException
-
This function/method 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 abstract void setAbsence(boolean value) throws FmcException
-
This function/method sets the absence indication of the logged-on user to
the specified value (action call).
When a person is absent, this person does not participate in staff
resolution, that is, this person does not get assigned any work
items.
- Parameters:
- value
- Returns the numeric value of the enumeration object.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
setSubstitute
public abstract void setSubstitute(String substitute) throws FmcException
-
This function/method 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.
- Throws: FmcException
- thrown if an API error or a communication error occurred.
All Packages Class Hierarchy This Package Previous Next Index