public interface IBPMOrganizationService
Modifier and Type | Method and Description |
---|---|
void |
addParticipantPropertyValue(IBPMContext ctx, ParticipantProperty property)
This API may only be called by an Administrator and it defines a new value or multiple new values for an existing STRING type extended user property already defined in the system.
|
ApplicationRoleOrgUnitCalendarAssociation |
createApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, ApplicationRoleOrgUnitCalendarAssociation applicationRoleOrgUnitCalendarAssociation)
createApplicationRoleOrgUnitCalendarAssociation API can be used to create a mapping between ApplicationRole, OrganizationalUnit, and CalendarRule.
|
void |
createAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String appRoleName, java.lang.String optionalDisplayName, java.lang.String optionalDesc)
Creates an app role within the application context
|
BusinessParameter |
createBusinessParameter(IBPMContext ctx, BusinessParameter businessParameter)
createBusinessParameter API will allow you to Create a Business Parameter.
|
CalendarRule |
createCalendarRule(IBPMContext ctx, CalendarRule cal)
Create Calendar rule.
|
FiscalYear |
createFiscalYear(IBPMContext ctx, FiscalYear fiscalYear)
Create Fiscal Year.
|
HolidayRule |
createHolidayRule(IBPMContext ctx, HolidayRule holidayRule)
Create HolidayRule If id is specified in HolidayRule object, it would be honored.
|
LogicalPeopleGroup |
createLogicalPeopleGroup(IBPMContext ctx, LogicalPeopleGroup lpg, boolean isExecuteImmediate)
Creates LogicalPeopleGroup
|
OrganizationalUnit |
createOrganizationalUnit(IBPMContext ctx, OrganizationalUnit organizationalUnit)
createOrganizationalUnit API can be used to create an OrganizationalUnit.
|
OrgUnitBusinessConstantAssociation |
createOrgUnitBusinessConstantAssociation(IBPMContext ctx, OrgUnitBusinessConstantAssociation orgUnitBusinessConstantAssociation)
createOrgUnitBusinessConstantAssociation API can be used to create a mapping between OrganizationalUnit and BusinessConstant.
|
void |
createParticipantProperty(IBPMContext ctx, ParticipantProperty property)
This API may only be called by an Administrator and it defines a new extended user property in the system.
|
void |
deleteAllPropertiesOnParticipants(IBPMContext ctx, java.util.List<Participant> participants)
Allows client to delete all properties defined on the list of participants provided.
|
void |
deleteApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, java.lang.String applicationRoleOrgUnitCalendarAssociationId)
deleteApplicationRoleOrgUnitCalendarAssociation API can be used to delete an ApplicationRoleOrgUnitCalendarAssociation.
|
void |
deleteBusinessParameter(IBPMContext ctx, java.lang.String businessParameterID, boolean force)
getBusinessParameter API will delete a Business Parameter.
|
void |
deleteCalendarRule(IBPMContext ctx, java.lang.String calendarID, boolean force)
Deletes a calendar rule Administrative privilege is needed to call this method
|
void |
deleteFiscalYear(IBPMContext ctx, java.lang.String fiscalYearID, boolean force)
Deletes a Fiscal Year Administrative privilege is needed to call this method
|
void |
deleteHolidayRule(IBPMContext ctx, java.lang.String holidayRuleId, boolean force)
Deletes a HolidayRule Administrative privilege is needed to call this method
|
void |
deleteLogicalPeopleGroup(IBPMContext ctx, java.lang.String lpgId, boolean force)
Deletes LogicalPeopleGroup
|
void |
deleteOrganizationalUnit(IBPMContext ctx, java.lang.String organizationalUnitId, boolean includingChildren, boolean force)
deleteOrganiztionalUnit API can be used to delete an OrganizationalUnit.
|
void |
deleteOrgUnitBusinessConstantAssociation(IBPMContext ctx, java.lang.String orgUnitBusinessConstantAssociationId)
deleteOrgUnitBusinessConstantAssociation API can be used to delete an OrgUnitBusinessConstantAssociation.
|
void |
deleteParticipantProperty(IBPMContext ctx, ParticipantProperty property, boolean force)
This API may only be called by an Administrator and it deletes an extended user property defined in the system.
|
void |
deleteParticipantPropertyValue(IBPMContext ctx, ParticipantProperty property, boolean force)
This API may only be called by an Administrator and it deletes a value or multiple values of a String property defined in the system.
|
java.util.List<Participant> |
executePeopleQuery(IBPMContext ctx, PeopleQuery peopleQuery, PeopleQueryContext peopleQueryCtx)
Executes peopleQuery
|
Organization |
exportOrganization(IBPMContext ctx)
exportOrganization API can be used to obtain the entire Organization, which consists of a hierarchy of OrganizationalUnits, ApplicationRoleOrgUnitCalendarAssociations, HolidayRules, Calendar Rules, Extended user properties, etc.
|
java.util.List<ParticipantProperties> |
getAllAssignedParticipantProperties(IBPMContext ctx)
Retrieves all the properties that are currently assigned to all the participants in the system.
|
java.util.List<ApplicationRoleOrgUnitCalendarAssociation> |
getApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, RoleProfile applicationRole)
getApplicationRoleOrgUnitCalendarAssociation API can be used to retrieve all the ApplicationRoleOrgUnitCalendarAssociation for the given Application Role
|
BusinessConstant |
getBusinessConstantForOU(IBPMContext ctx, java.lang.String organizationalUnitId, java.lang.String businessConstantName)
getBusinessParameter API will fetch the BusinessConstant associated with the OrganizationUnit.
|
BusinessParameter |
getBusinessParameter(IBPMContext ctx, java.lang.String businessParameterID)
getBusinessParameter API will fetch the BusinessParameter associated with the businessParameterID.
|
CalendarRule |
getCalendarRule(IBPMContext ctx, java.lang.String organizationalUnitId)
getCalendarRule API will fetch the CalendarRule associated with the OrganizationalUnit.
|
CalendarRule |
getCalendarRuleForRole(IBPMContext ctx, java.lang.String organizationalUnitId, RoleProfile applicationRole)
getCalendarRule API will fetch the CalendarRule associated with the ApplicationRole in the given OrganizationalUnit.
|
FiscalYear |
getFiscalYear(IBPMContext ctx, java.lang.String fiscalYearID)
getFiscalYear API will fetch the FiscalYear associated with the OrganizationalUnit.
|
HolidayRule |
getHolidayRule(IBPMContext ctx, java.lang.String holidayRuleId)
Gets a Holiday Rule object.
|
LogicalPeopleGroup |
getLogicalPeopleGroup(IBPMContext ctx, java.lang.String lpgId)
Gets LogicalPeopleGroup
|
java.util.List<Participant> |
getLogicalPeopleGroupMembers(IBPMContext ctx, java.lang.String lpgId)
Gets LogicalPeopleGroup's members from the LPG cache
|
java.util.List<LogicalPeopleGroup> |
getLogicalPeopleGroupsForUser(IBPMContext ctx, PrincipleRefType user)
Gets LogicalPeopleGroup
|
OrganizationalUnit |
getOrganizationalUnit(IBPMContext ctx, java.lang.String organizationalUnitId, ChildOrganizationalUnitRetrievalModeTypeEnum childOrganizationalUnitRetrievalMode)
getOrganizationalUnit API can be used to fetch an OrganizationalUnit given its OrganizationalUnitId.
|
java.util.List<OrganizationalUnit> |
getOrganizationalUnitForUser(IBPMContext ctx, java.lang.String userId, java.lang.String identityContext, boolean direct) |
java.util.List<OrgUnitBusinessConstantAssociation> |
getOrgUnitBusinessConstantAssociationsForOU(IBPMContext ctx, java.lang.String organizationalUnitId)
getOrgUnitBusinessConstantAssociationsForOU API can be used to retrieve all the OrgUnitBusinessConstantAssociation for the given OrganizationUnitId
|
java.util.List<Participant> |
getParticipantsWithProperties(IBPMContext ctx, java.util.List<Participant> setOfParticipants, java.util.List<ParticipantProperty> props, int startRow, int endRow)
Get a list of participants which have the specified properties defined on them.
|
java.util.List<ParticipantProperties> |
getPropertiesOfParticipants(IBPMContext ctx, java.util.List<Participant> participants)
Retrieves properties defined on the participants.
|
void |
grantAppRoleToPrincipal(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Participant participant)
Grants an appRole to the specified Principal
|
void |
grantPermissionToAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Permission perm)
Grants Permission to AppRole
|
Organization |
importOrganization(IBPMContext ctx, Organization organization, boolean validateUsers)
importOrganization API can be used to import an entire Organization, which consists of a hierarchy of OrganizationalUnits, ApplicationRoleOrgUnitCalendarAssociations, HolidayRules, Calendar Rules, Extended user properties, etc.
|
void |
removeAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String appRoleName, boolean force)
Deletes an app role from the policy store
|
void |
revokeAppRoleFromPrincipal(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Participant participant)
Revokes an appRole from the specified Principal
|
void |
revokePermissionFromAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Permission perm)
Revokes the permission from an AppRole
|
java.util.List<ParticipantProperty> |
searchExtendedUserProperties(IBPMContext ctx, java.lang.String propertyName)
Retrieve all property definitions that match the provided name.
|
java.util.List<LogicalPeopleGroup> |
searchLogicalPeopleGroups(IBPMContext ctx, SearchModeTypeEnum searchMode, java.lang.String searchCriteria, int startRow, int endRow)
Searches LogicalPeopleGroup
|
java.util.List |
searchOrganizationEntity(IBPMContext ctx, OrganizationEntityTypeEnum organizationEntity, SearchModeTypeEnum searchMode, java.lang.String searchCriteria, int startRow, int endRow)
Deprecated.
|
java.util.List |
searchOrganizationEntity(IBPMContext ctx, OrganizationEntityTypeEnum organizationEntity, SearchModeTypeEnum searchMode, java.lang.String searchCriteria, int startRow, int endRow, OrganizationEntitySearchContext organizationEntitySearchContext)
searchOrganizationEntity can be used to search for any organization entity like OrganizationalUnit, Role, HolidayRule, CalendarRule, FiscalYear, Extended User etc.
|
java.util.List<Participant> |
searchParticipantsWithProperties(IBPMContext ctx, java.util.List<Participant> setOfParticipants, Predicate predicate, int startRow, int endRow)
Get a list of participants which have the specified properties defined on them.
|
void |
setPropertiesOnParticipants(IBPMContext ctx, java.util.List<ParticipantProperties> properties)
Allows client to define properties on a set of participants.
|
ApplicationRoleOrgUnitCalendarAssociation |
updateApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, ApplicationRoleOrgUnitCalendarAssociation applicationRoleOrgUnitCalendarAssociation)
updateApplicationRoleOrgUnitCalendarAssociation API can be used to update the Calendar and OrganizationalUnit of this association.
|
BusinessParameter |
updateBusinessParameter(IBPMContext ctx, BusinessParameter businessParameter)
updateBusinessParameter API will allow you to update a Business Parameter Administrative privilege is needed to call this method
|
CalendarRule |
updateCalendarRule(IBPMContext ctx, CalendarRule updatedCalendar)
Updates a calendar rule Administrative privilege is needed to call this method
|
FiscalYear |
updateFiscalYear(IBPMContext ctx, FiscalYear updatedFiscalYear)
Updates a Fiscal Year Administrative privilege is needed to call this method
|
HolidayRule |
updateHolidayRule(IBPMContext ctx, HolidayRule updatedHolidayRule)
Updates a HolidayRule Administrative privilege is needed to call this method
|
LogicalPeopleGroup |
updateLogicalPeopleGroup(IBPMContext ctx, LogicalPeopleGroup lpg, boolean isExecuteImmediate)
Updates LogicalPeopleGroup
|
OrganizationalUnit |
updateOrganizationalUnit(IBPMContext ctx, OrganizationalUnit organizationalUnit)
updateOrganizationalUnit API can be used to update any changes to the OrganizationalUnit including specifying/changing the description of the OrganizationalUnit, CalendarRule, Members, ManagedByMembers, Children OrganizationalUnits, etc.
|
OrgUnitBusinessConstantAssociation |
updateOrgUnitBusinessConstantAssociation(IBPMContext ctx, OrgUnitBusinessConstantAssociation orgUnitBusinessConstantAssociation)
updateOrgUnitBusinessConstantAssociation API can be used to update the BusinessConstant and OrganizationalUnit of this association.
|
void |
updateOrgUnitBusinessConstantAssociationsForOU(IBPMContext ctx, java.lang.String organizationalUnitId, java.util.List<OrgUnitBusinessConstantAssociation> orgUnitBusinessConstantAssociations)
updateOrgUnitBusinessConstantAssociation API can be used to update all the BusinessConstants of an OrganizationalUnit.
|
void |
updateParticipantPropertyName(IBPMContext ctx, java.lang.String oldName, java.lang.String newname)
This API may only be called by an Administrator and it changes the name of an existing property.
|
void |
updateParticipantPropertyValue(IBPMContext ctx, java.lang.String propertyName, java.lang.String oldValue, java.lang.String newValue)
This API may only be called by an Administrator and it changes the value defined for an existing STRING property.
|
FiscalYear getFiscalYear(IBPMContext ctx, java.lang.String fiscalYearID) throws BPMOrganizationException
ctx
- the workflow contextfiscalYearID
- the fiscalYearID String value of the Fiscal YearBPMOrganizationException
- any exception thrown during queryFiscalYear createFiscalYear(IBPMContext ctx, FiscalYear fiscalYear) throws BPMOrganizationException
ctx
- an authenticated IBPMContextfiscalYear
- is the fiscal year to be createdBPMOrganizationException
- if Fiscal Year with same name has already been created.FiscalYear updateFiscalYear(IBPMContext ctx, FiscalYear updatedFiscalYear) throws BPMOrganizationException
ctx
- an authenticated IBPMContextupdatedFiscalYear
-BPMOrganizationException
void deleteFiscalYear(IBPMContext ctx, java.lang.String fiscalYearID, boolean force) throws BPMOrganizationException
ctx
- an authenticated IBPMContextfiscalYearID
- is Fiscal Year identifier - guidforce
-BPMOrganizationException
java.util.List<ParticipantProperty> searchExtendedUserProperties(IBPMContext ctx, java.lang.String propertyName) throws BPMOrganizationException
propertyName
- must not be null or empty.BPMOrganizationException
- if any error occurs during the search.java.util.List<ParticipantProperties> getAllAssignedParticipantProperties(IBPMContext ctx) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
BPMOrganizationException
- If an error is thrown by the database.java.util.List<LogicalPeopleGroup> getLogicalPeopleGroupsForUser(IBPMContext ctx, PrincipleRefType user) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.user
- a PrincipalRefType
objectLogicalPeopleGroup
objects which the user belong to.BPMOrganizationException
java.util.List<OrganizationalUnit> getOrganizationalUnitForUser(IBPMContext ctx, java.lang.String userId, java.lang.String identityContext, boolean direct) throws BPMOrganizationException
BPMOrganizationException
java.util.List searchOrganizationEntity(IBPMContext ctx, OrganizationEntityTypeEnum organizationEntity, SearchModeTypeEnum searchMode, java.lang.String searchCriteria, int startRow, int endRow) throws BPMOrganizationException
BPMOrganizationException
java.util.List searchOrganizationEntity(IBPMContext ctx, OrganizationEntityTypeEnum organizationEntity, SearchModeTypeEnum searchMode, java.lang.String searchCriteria, int startRow, int endRow, OrganizationEntitySearchContext organizationEntitySearchContext) throws BPMOrganizationException
ctx
- the workflow contextorganizationEntity
- the OrganizationEntity to be searched forsearchMode
- the SearchMode used to specify the type of search like beginsWith, endsWith, contains, like, equalsstartRow
- the rownum of the starting row for this query (set to 0 for no paging)endRow
- the rownum of the ending row for this query (set to 0 for no paging)organizationEntitySearchContext
- the OrganizationEntity search contextBPMOrganizationException
- any exception thrown during the searchOrganizationalUnit createOrganizationalUnit(IBPMContext ctx, OrganizationalUnit organizationalUnit) throws BPMOrganizationException
ctx
- the workflow contextorganizationalUnit
- the OrganizationalUnit to be createdBPMOrganizationException
- any exception thrown during the creationOrganizationalUnit updateOrganizationalUnit(IBPMContext ctx, OrganizationalUnit organizationalUnit) throws BPMOrganizationException
ctx
- the workflow contextorganizationalUnit
- the OrganizationalUnit that contains the updated informationtrue
if update succeeded, otherwise false
BPMOrganizationException
- any exception thrown during the updatevoid deleteOrganizationalUnit(IBPMContext ctx, java.lang.String organizationalUnitId, boolean includingChildren, boolean force) throws BPMOrganizationException
ctx
- the workflow contextorganizationalUnitId
- the organizationalUnitId String value of the OrganizationalUnit to be deletedincludingChildren
- If this boolean flag is true
, the entire hirearchy of children will be deleted. If it is false
, then none of the children will be deleted and the parent of the first level children will become null.force
-BPMOrganizationException
- any exception thrown during deletionOrganizationalUnit getOrganizationalUnit(IBPMContext ctx, java.lang.String organizationalUnitId, ChildOrganizationalUnitRetrievalModeTypeEnum childOrganizationalUnitRetrievalMode) throws BPMOrganizationException
ctx
- the workflow contextorganizationalUnitId
- the organizationalUnitId String valuechildOrganizationalUnitRetrievalMode
- the ChildOrganizationalUnitRetrievalMode to specify how the children of this OrganizationalUnit needs to be retrievedBPMOrganizationException
- any exception thrown during the queryCalendarRule getCalendarRule(IBPMContext ctx, java.lang.String organizationalUnitId) throws BPMOrganizationException
ctx
- the workflow contextorganizationalUnitId
- the organizationalUnitId String value of the OrganizationalUnitBPMOrganizationException
- any exception thrown during queryCalendarRule getCalendarRuleForRole(IBPMContext ctx, java.lang.String organizationalUnitId, RoleProfile applicationRole) throws BPMOrganizationException
ctx
- the workflow contextorganizationalUnitId
- the organizationalUnitId String value of the OrganizationalUnitapplicationRole
- the RoleProfile that defines the ApplicationRoleBPMOrganizationException
- any exception thrown during queryCalendarRule createCalendarRule(IBPMContext ctx, CalendarRule cal) throws BPMOrganizationException
ctx
- an authenticated IBPMContextcal
- is the calendar to be createdBPMOrganizationException
- if calendar with same name has already been created.CalendarRule updateCalendarRule(IBPMContext ctx, CalendarRule updatedCalendar) throws BPMOrganizationException
ctx
- an authenticated IBPMContextupdatedCalendar
-BPMOrganizationException
void deleteCalendarRule(IBPMContext ctx, java.lang.String calendarID, boolean force) throws BPMOrganizationException
ctx
- an authenticated IBPMContextcalendarID
- is calendar identifier - guidforce
-BPMOrganizationException
HolidayRule getHolidayRule(IBPMContext ctx, java.lang.String holidayRuleId) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
HolidayRuleId
- unique Id of the holiday rule to be fetched.BPMOrganizationException
HolidayRule createHolidayRule(IBPMContext ctx, HolidayRule holidayRule) throws BPMOrganizationException
ctx
- an authenticated IBPMContextholidays
- is the HolidayList to be createdBPMOrganizationException
- is holiday list with same name has already been created.HolidayRule updateHolidayRule(IBPMContext ctx, HolidayRule updatedHolidayRule) throws BPMOrganizationException
ctx
- an authenticated IBPMContextupdatedHolidayRule
-BPMOrganizationException
void deleteHolidayRule(IBPMContext ctx, java.lang.String holidayRuleId, boolean force) throws BPMOrganizationException
ctx
- an authenticated IBPMContextHolidayRuleId
- is HolidayRule identifierforce
-BPMOrganizationException
java.util.List<ParticipantProperties> getPropertiesOfParticipants(IBPMContext ctx, java.util.List<Participant> participants) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
participants
- List of Participants whose properties need to be fetched.BPMOrganizationException
- If an error is thrown by the database.void setPropertiesOnParticipants(IBPMContext ctx, java.util.List<ParticipantProperties> properties) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
properties
- List of properties to be defined on the participant in the ParticipantProperties instance.BPMOrganizationException
- If an error is thrown by the database.void deleteAllPropertiesOnParticipants(IBPMContext ctx, java.util.List<Participant> participants) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
participants
- List of Participants whose properties need to be deleted.BPMOrganizationException
- If an error is thrown by the database.java.util.List<Participant> searchParticipantsWithProperties(IBPMContext ctx, java.util.List<Participant> setOfParticipants, Predicate predicate, int startRow, int endRow) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
setOfParticipants
- List of Participants to search within to find those with matching propertiespredicate
- Contains the search criteria defined using property names and their values. Eg. SKILL = 'Java' AND HIRE_DATE > '10/10/2009'startRow
- Indicates the start row in the result set from which to include rows in the returned listendRow
- Indicates the end row in the result set after which no rows from the result set are included in the returned listBPMOrganizationException
- If the Predicate specifies any properties that are not defined in the system or specifies any values for STRING properties that are not defined in the system or if the Predicate instance is NULL or if Toplink throws an error or if the database throws an error.java.util.List<Participant> getParticipantsWithProperties(IBPMContext ctx, java.util.List<Participant> setOfParticipants, java.util.List<ParticipantProperty> props, int startRow, int endRow) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
setOfParticipants
- List of Participants to search within to find those with matching propertiesprops
- Contains the search criteria defined using property names and their values. Eg. SKILL = 'Java' AND HIRE_DATE = '10/10/2009'BPMOrganizationException
- If the list of properties specifies a property name which is not defined in the system or specifies any values for STRING properties that are not defined in the system or if the props list is NULL or if Toplink throws an error or if the database throws an error.void createParticipantProperty(IBPMContext ctx, ParticipantProperty property) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
property
- An instance of ParticipantProperty which defines the property name and in case of String properties, it's values that are to be defined. Date and Number type properties do not have a value defined for them.BPMOrganizationException
- If the property is already defined or if values have been specified in the definition of NUMBER or DATE properties or if the database throws as error.void addParticipantPropertyValue(IBPMContext ctx, ParticipantProperty property) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
property
- An instance of ParticipantProperty which specifies the name of an existing STRING property defined in the system as well as supplies the new value(s) which are to be associated with this property.BPMOrganizationException
- If the value is already defined on the STRING property or if the specified property is defined as a NUMBER or a DATE property or if the database throws as error.void deleteParticipantProperty(IBPMContext ctx, ParticipantProperty property, boolean force) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
property
- An instance of ParticipantProperty which specifies the name of the property to be deleted.force
- If set to TRUE, will cause the property to be unassigned from the various participants to whom it has been assigned and then deleted from the system. Use this flag with caution.BPMOrganizationException
- If the specified property is not defined in the system or if the force flag is set to false and the property being deleted is assigned to participants or if the database throws as error.void deleteParticipantPropertyValue(IBPMContext ctx, ParticipantProperty property, boolean force) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
property
- An instance of ParticipantProperty which specifies the name of the property to be deleted.force
- If set to TRUE, will cause the property to be unassigned from the various participants to whom it has been assigned and then deleted from the system. Use this flag with caution.BPMOrganizationException
- If the specified property value is not defined on the STRING property in the system or if the force flag is set to false and the specified value is assigned to participants or if the database throws as error.void updateParticipantPropertyName(IBPMContext ctx, java.lang.String oldName, java.lang.String newname) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
oldName
- The existing name of the property.newname
- The new name of the same property definition.BPMOrganizationException
- If the oldName specified in the input does not match any property defined in the system or if the database throws as error.void updateParticipantPropertyValue(IBPMContext ctx, java.lang.String propertyName, java.lang.String oldValue, java.lang.String newValue) throws BPMOrganizationException
ctx
- an authenticated IBPMContext
propertyName
- The name of the property whose value needs to be updated.oldName
- The existing name of the property.newname
- The new name of the same property definition.BPMOrganizationException
- If the specified propertyName does not exist in the system or it exists but it does not have the oldValue specified in the input or if the database throws an error.LogicalPeopleGroup createLogicalPeopleGroup(IBPMContext ctx, LogicalPeopleGroup lpg, boolean isExecuteImmediate) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.lpg
- a LogicalPeopleGroup
objectisExecuteImmediate
- a boolean flag. If true LogicalPeopleGroup membership is defined immediatelyLogicalPeopleGroup
objectBPMOrganizationException
LogicalPeopleGroup updateLogicalPeopleGroup(IBPMContext ctx, LogicalPeopleGroup lpg, boolean isExecuteImmediate) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.lpg
- a LogicalPeopleGroup
objectisExecuteImmediate
- a boolean flag. If true LogicalPeopleGroup membership is defined immediatelyLogicalPeopleGroup
objectBPMOrganizationException
void deleteLogicalPeopleGroup(IBPMContext ctx, java.lang.String lpgId, boolean force) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.lpgId
- an unique LogicalPeopleGroup idforce
-BPMOrganizationException
LogicalPeopleGroup getLogicalPeopleGroup(IBPMContext ctx, java.lang.String lpgId) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.lpgId
- an unique LogicalPeopleGroup idLogicalPeopleGroup
objectBPMOrganizationException
java.util.List<LogicalPeopleGroup> searchLogicalPeopleGroups(IBPMContext ctx, SearchModeTypeEnum searchMode, java.lang.String searchCriteria, int startRow, int endRow) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.searchMode
- the SearchMode used to specify the type of search like beginsWith, endsWith, contains, like, equalsstartRow
- the rownum of the starting row for this query (set to 0 for no paging)endRow
- the rownum of the ending row for this query (set to 0 for no paging)BPMOrganizationException
- if any exception thrown during the searchjava.util.List<Participant> getLogicalPeopleGroupMembers(IBPMContext ctx, java.lang.String lpgId) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.lpgId
- an unique LogicalPeopleGroup idParticipant
object, members of the LogicalPeopleGroup
objectsBPMOrganizationException
java.util.List<Participant> executePeopleQuery(IBPMContext ctx, PeopleQuery peopleQuery, PeopleQueryContext peopleQueryCtx) throws BPMOrganizationException
ctx
- authenticated IWorkflowContext
for user.peopleQuery
- a PeopleQuery
objectpeopleQueryCtx
- a runtime people query context, a list of argumnets, a name-value pair of argument name and its values. All argument's name must start from '$' characterBPMOrganizationException
void createAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String appRoleName, java.lang.String optionalDisplayName, java.lang.String optionalDesc) throws BPMOrganizationException
wctx
- an authenticated IBPMContext
appCtx
- The application context in which the appRole has to be createdappRoleName
- The name of the appRole which will be createddisplayName
- The display name of the appRoledesc
- Description of the appRoleBPMOrganizationException
void removeAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String appRoleName, boolean force) throws BPMOrganizationException
wctx
- an authenticated IBPMContext
appCtx
- The application context from which the appRole has to be deletedappRoleName
- The name of the appRole which will be deletedforce
-BPMOrganizationException
void grantAppRoleToPrincipal(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Participant participant) throws BPMOrganizationException
wctx
- an authenticated IBPMContext
appCtx
- The application contextappRole
- AppRole object to be grantedparticipants
- Participant objects to which the appRole has to be grantedBPMOrganizationException
void revokeAppRoleFromPrincipal(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Participant participant) throws BPMOrganizationException
wctx
- an authenticated IBPMContext
appCtx
- The application contextappRole
- AppRole object to be revokedparticipants
- Participant objects from which the appRole has to be revokedBPMOrganizationException
void grantPermissionToAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Permission perm) throws BPMOrganizationException
wctx
- an authenticated IBPMContext
appCtx
- The application contextappRole
- AppRole object to be granted the permissionperm
- Permission object which has to be granted to the appRoleBPMOrganizationException
void revokePermissionFromAppRole(IBPMContext wctx, ApplicationContext appCtx, java.lang.String approleName, Permission perm) throws BPMOrganizationException
wctx
- an authenticated IBPMContext
appCtx
- The application contextappRole
- AppRole object from which the permission is revokedperm
- Permission object which has to be revokedBPMOrganizationException
ApplicationRoleOrgUnitCalendarAssociation createApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, ApplicationRoleOrgUnitCalendarAssociation applicationRoleOrgUnitCalendarAssociation) throws BPMOrganizationException
ctx
- the workflow contextapplicationRoleOrgUnitCalendarAssociation
- the ApplicationRoleOrgUnitCalendarAssociation to be createdBPMOrganizationException
- any exception thrown during the creationApplicationRoleOrgUnitCalendarAssociation updateApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, ApplicationRoleOrgUnitCalendarAssociation applicationRoleOrgUnitCalendarAssociation) throws BPMOrganizationException
ctx
- the workflow contextapplicationRoleOrgUnitCalendarAssociation
- the ApplicationRoleOrgUnitCalendarAssociation that contains the updated informationtrue
if update succeeded, otherwise false
BPMOrganizationException
- any exception thrown during the updatevoid deleteApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, java.lang.String applicationRoleOrgUnitCalendarAssociationId) throws BPMOrganizationException
ctx
- the workflow contextapplicationRoleOrgUnitCalendarAssociationId
- the applicationRoleOrgUnitCalendarAssociationId String value of the ApplicationRoleOrgUnitCalendarAssociation to be deletedBPMOrganizationException
- any exception thrown during deletionjava.util.List<ApplicationRoleOrgUnitCalendarAssociation> getApplicationRoleOrgUnitCalendarAssociation(IBPMContext ctx, RoleProfile applicationRole) throws BPMOrganizationException
ctx
- the workflow contextapplicationRole
- the RoleProfile that defines the ApplicationRoleBPMOrganizationException
- any exception thrown during queryOrganization exportOrganization(IBPMContext ctx) throws BPMOrganizationException
ctx
- the workflow contextBPMOrganizationException
- any exception thrown during exportOrganization importOrganization(IBPMContext ctx, Organization organization, boolean validateUsers) throws BPMOrganizationException
ctx
- the workflow contextorganization
- Organization to be importedvalidateUsers
- if true, users in hte orgUnits will be validated against the LDAPBPMOrganizationException
- any exception thrown during importBusinessParameter createBusinessParameter(IBPMContext ctx, BusinessParameter businessParameter) throws BPMOrganizationException
ctx
- an authenticated IBPMContextbusinessParameter
- is the Business Parameter to be createdBPMOrganizationException
- any exception thrown during the creationBusinessParameter updateBusinessParameter(IBPMContext ctx, BusinessParameter businessParameter) throws BPMOrganizationException
ctx
- an authenticated IBPMContextbusinessParameter
- is the Business Parameter to updateBPMOrganizationException
- any exception thrown during the updateBusinessParameter getBusinessParameter(IBPMContext ctx, java.lang.String businessParameterID) throws BPMOrganizationException
ctx
- an authenticated IBPMContextbusinessParameterID
- is Business Parameter identifierBPMOrganizationException
- any exception thrown during queryvoid deleteBusinessParameter(IBPMContext ctx, java.lang.String businessParameterID, boolean force) throws BPMOrganizationException
ctx
- an authenticated IBPMContextbusinessParameterID
- is businessParameter identifierforce
- true if you want to delete the OrgUnitBusinessConstantAssociation associated to it false if you want not to delete the Business Parameter in case it has an associationBPMOrganizationException
- any exception thrown during the deletionBusinessConstant getBusinessConstantForOU(IBPMContext ctx, java.lang.String organizationalUnitId, java.lang.String businessConstantName) throws BPMOrganizationException
ctx
- an authenticated IBPMContextorganizationalUnitId
- the organizationalUnitId String value of the Organizational UnitBPMOrganizationException
- any exception thrown during queryOrgUnitBusinessConstantAssociation createOrgUnitBusinessConstantAssociation(IBPMContext ctx, OrgUnitBusinessConstantAssociation orgUnitBusinessConstantAssociation) throws BPMOrganizationException
ctx
- an authenticated IBPMContextorgUnitBusinessConstantAssociation
- the OrgUnitBusinessConstantAssociation to be createdBPMOrganizationException
- any exception thrown during the creationvoid deleteOrgUnitBusinessConstantAssociation(IBPMContext ctx, java.lang.String orgUnitBusinessConstantAssociationId) throws BPMOrganizationException
ctx
- an authenticated IBPMContextorgUnitBusinessConstantAssociationId
- the orgUnitBusinessConstantAssociationId String value of the OrgUnitBusinessConstantAssociation to be deletedBPMOrganizationException
- any exception thrown during deletionjava.util.List<OrgUnitBusinessConstantAssociation> getOrgUnitBusinessConstantAssociationsForOU(IBPMContext ctx, java.lang.String organizationalUnitId) throws BPMOrganizationException
ctx
- an authenticated IBPMContextorganizationalUnitId
- the OrganizationUnitdId that defines the Organizational UnitBPMOrganizationException
- any exception thrown during queryOrgUnitBusinessConstantAssociation updateOrgUnitBusinessConstantAssociation(IBPMContext ctx, OrgUnitBusinessConstantAssociation orgUnitBusinessConstantAssociation) throws BPMOrganizationException
ctx
- an authenticated IBPMContextorgUnitBusinessConstantAssociation
- the OrgUnitBusinessConstantAssociation that contains the updated informationBPMOrganizationException
- any exception thrown during the updatevoid updateOrgUnitBusinessConstantAssociationsForOU(IBPMContext ctx, java.lang.String organizationalUnitId, java.util.List<OrgUnitBusinessConstantAssociation> orgUnitBusinessConstantAssociations) throws BPMOrganizationException, java.lang.IllegalArgumentException
ctx
- an authenticated IBPMContextorganizationalUnitId
- - Id of the organizational unitorgUnitBusinessConstantAssociations
- -the list of all OrgUnitBusinessConstantAssociations for orgUnit - if the list involves other OU, an exception is thrown - BusinessConstants not in this list will be treated as deletedBPMOrganizationException
- any exception thrown during the update *java.lang.IllegalArgumentException