public interface WorkflowRulesManager extends OsidManager, WorkflowRulesProfile
The workflow rules manager provides access to workflow rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
StepConstrainerLookupSession:
a session to
retrieve step constrainer StepConstrainerQuerySession:
a session to query
for step constrainer StepConstrainerSearchSession:
a session to search
for step constrainer StepConstrainerAdminSession:
a session to create
and delete step constrainer StepConstrainerNotificationSession:
a session to
receive notifications pertaining to step constrainer changes StepConstrainerOfficeSession:
a session to look up
step constrainer office mappings StepConstrainerOfficeAssignmentSession:
a session
to manage step constrainer to office mappings StepConstrainerSmartOfficeSession:
a session to
manage dynamic office of step constrainer StepConstrainerRuleLookupSession:
a session to
look up step constrainer to step mappings StepConstrainerRuleApplicationSession:
a session
to apply step constrainer to steps StepConstrainerEnablerLookupSession:
a session to
retrieve step constrainer enablers StepConstrainerEnablerQuerySession:
a session to
query for step constrainer enablers StepConstrainerEnablerSearchSession:
a session to
search for step constrainer enablers StepConstrainerEnablerAdminSession:
a session to
create and delete step constrainer enablers StepConstrainerEnablerNotificationSession:
a
session to receive notifications pertaining to step constrainer
enabler changes StepConstrainerEnablerOfficeSession:
a session to
look up step constrainer enabler office mappings StepConstrainerEnablerOfficeAssignmentSession:
a
session to manage step constrainer enabler to office mappings StepConstrainerEnablerSmartOfficeSession:
a
session to manage dynamic office of step constrainer enablers StepConstrainerEnableRuleLookupSession:
a session
to look up step constrainer enabler mappings StepConstrainerEnablerRuleApplicationSession:
a
session to apply step constrainer enablers StepProcessorLookupSession:
a session to retrieve
step processor StepProcessorQuerySession:
a session to query for
step processor StepProcessorSearchSession:
a session to search
for step processor StepProcessorAdminSession:
a session to create and
delete step processor StepProcessorNotificationSession:
a session to
receive notifications pertaining to step processor changes StepProcessorOfficeSession:
a session to look up
step processor office mappings StepProcessorOfficeAssignmentSession:
a session to
manage step processor to office mappings StepProcessorSmartOfficeSession:
a session to
manage dynamic office of step processor StepProcessorRuleLookupSession:
a session to look
up step processor to step mappings StepProcessorRuleApplicationSession:
a session to
apply step processor to steps StepProcessorEnablerLookupSession:
a session to
retrieve step processor enablers StepProcessorEnablerQuerySession:
a session to
query for step processor enablers StepProcessorEnablerSearchSession:
a session to
search for step processor enablers StepProcessorEnablerAdminSession:
a session to
create and delete step processor enablers StepProcessorEnablerNotificationSession:
a session
to receive notifications pertaining to step processor enabler changes
StepProcessorEnablerOfficeSession:
a session to
look up step processor enabler office mappings StepProcessorEnablerOfficeAssignmentSession:
a
session to manage step processor enabler to office mappings StepProcessorEnablerSmartOfficeSession:
a session
to manage dynamic office of step processor enablers StepProcessorEnablerRuleLookupSession:
a session
to look up step processor enabler mappings StepProcessorEnablerRuleApplicationSession:
a
session to apply step processor enablers ProcessEnablerLookupSession:
a session to retrieve
process enabler ProcessEnablerQuerySession:
a session to query for
process enabler ProcessEnablerSearchSession:
a session to search
for process enabler ProcessEnablerAdminSession:
a session to create
and delete process enabler ProcessEnablerNotificationSession:
a session to
receive notifications pertaining to process enabler changes ProcessEnablerOfficeSession:
a session to look up
process enabler office mappings ProcessEnablerOfficeAssignmentSession:
a session
to manage process enabler to office mappings ProcessEnablerSmartOfficeSession:
a session to
manage dynamic office of process enabler ProcessEnablerRuleLookupSession:
a session to look
up process enabler to process mappings ProcessEnablerRuleApplicationSession:
a session to
apply process enabler to processs Modifier and Type | Method and Description |
---|---|
ProcessEnablerAdminSession |
getProcessEnablerAdminSession()
Gets the
OsidSession associated with the process
enabler administration service. |
ProcessEnablerAdminSession |
getProcessEnablerAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the process
enabler administration service for the given office. |
ProcessEnablerLookupSession |
getProcessEnablerLookupSession()
Gets the
OsidSession associated with the process
enabler lookup service. |
ProcessEnablerLookupSession |
getProcessEnablerLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the process
enabler lookup service for the given office. |
ProcessEnablerNotificationSession |
getProcessEnablerNotificationSession(ProcessEnablerReceiver processEnablerReceiver)
Gets the
OsidSession associated with the process
enabler notification service. |
ProcessEnablerNotificationSession |
getProcessEnablerNotificationSessionForOffice(ProcessEnablerReceiver processEnablerReceiver,
Id officeId)
Gets the
OsidSession associated with the process
enabler notification service for the given office. |
ProcessEnablerOfficeAssignmentSession |
getProcessEnablerOfficeAssignmentSession()
Gets the
OsidSession associated with assigning process
enabler to office. |
ProcessEnablerOfficeSession |
getProcessEnablerOfficeSession()
Gets the
OsidSession to lookup process enabler/office
mappings for process enablers. |
ProcessEnablerQuerySession |
getProcessEnablerQuerySession()
Gets the
OsidSession associated with the process
enabler query service. |
ProcessEnablerQuerySession |
getProcessEnablerQuerySessionForOffice(Id officeId)
Gets the
OsidSession associated with the process
enabler query service for the given office. |
ProcessEnablerRuleApplicationSession |
getProcessEnablerRuleApplicationSession()
Gets the
OsidSession associated with the process
enabler assignment service to apply to processs. |
ProcessEnablerRuleApplicationSession |
getProcessEnablerRuleApplicationSessionForOffice(Id officeId)
Gets the
OsidSession associated with the process
enabler assignment service for the given office to apply to processs. |
ProcessEnablerRuleLookupSession |
getProcessEnablerRuleLookupSession()
Gets the
OsidSession associated with the process
enabler mapping lookup service for looking up the rules applied to the
process. |
ProcessEnablerRuleLookupSession |
getProcessEnablerRuleLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the process
enabler mapping lookup service for the given office for looking up
rules applied to a process. |
ProcessEnablerSearchSession |
getProcessEnablerSearchSession()
Gets the
OsidSession associated with the process
enabler search service. |
ProcessEnablerSearchSession |
getProcessEnablerSearchSessionForOffice(Id officeId)
Gets the
OsidSession associated with the process
enabler earch service for the given office. |
ProcessEnablerSmartOfficeSession |
getProcessEnablerSmartOfficeSession(Id officeId)
Gets the
OsidSession to manage process enabler smart
office. |
StepConstrainerAdminSession |
getStepConstrainerAdminSession()
Gets the
OsidSession associated with the step
constrainer administration service. |
StepConstrainerAdminSession |
getStepConstrainerAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer administration service for the given office. |
StepConstrainerEnablerAdminSession |
getStepConstrainerEnablerAdminSession()
Gets the
OsidSession associated with the step
constrainer enabler administration service. |
StepConstrainerEnablerAdminSession |
getStepConstrainerEnablerAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer enabler administration service for the given office. |
StepConstrainerEnablerLookupSession |
getStepConstrainerEnablerLookupSession()
Gets the
OsidSession associated with the step
constrainer enabler lookup service. |
StepConstrainerEnablerLookupSession |
getStepConstrainerEnablerLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer enabler lookup service for the given office. |
StepConstrainerEnablerNotificationSession |
getStepConstrainerEnablerNotificationSession(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver)
Gets the
OsidSession associated with the step
constrainer enabler notification service. |
StepConstrainerEnablerNotificationSession |
getStepConstrainerEnablerNotificationSessionForOffice(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver,
Id officeId)
Gets the
OsidSession associated with the step
constrainer enabler notification service for the given office. |
StepConstrainerEnablerOfficeAssignmentSession |
getStepConstrainerEnablerOfficeAssignmentSession()
Gets the
OsidSession associated with assigning step
constrainer enablers to office. |
StepConstrainerEnablerOfficeSession |
getStepConstrainerEnablerOfficeSession()
Gets the
OsidSession to lookup step constrainer
enabler/office mappings for step constrainer enablers. |
StepConstrainerEnablerQuerySession |
getStepConstrainerEnablerQuerySession()
Gets the
OsidSession associated with the step
constrainer enabler query service. |
StepConstrainerEnablerQuerySession |
getStepConstrainerEnablerQuerySessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer enabler query service for the given office. |
StepConstrainerEnablerRuleApplicationSession |
getStepConstrainerEnablerRuleApplicationSession()
Gets the
OsidSession associated with the step
constrainer enabler assignment service. |
StepConstrainerEnablerRuleApplicationSession |
getStepConstrainerEnablerRuleApplicationSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer enabler assignment service for the given office. |
StepConstrainerEnablerRuleLookupSession |
getStepConstrainerEnablerRuleLookupSession()
Gets the
OsidSession associated with the step
constrainer enabler mapping lookup service. |
StepConstrainerEnablerRuleLookupSession |
getStepConstrainerEnablerRuleLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer enabler mapping lookup service for the given office. |
StepConstrainerEnablerSearchSession |
getStepConstrainerEnablerSearchSession()
Gets the
OsidSession associated with the step
constrainer enabler search service. |
StepConstrainerEnablerSearchSession |
getStepConstrainerEnablerSearchSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer enablers earch service for the given office. |
StepConstrainerEnablerSmartOfficeSession |
getStepConstrainerEnablerSmartOfficeSession(Id officeId)
Gets the
OsidSession to manage step constrainer enabler
smart office. |
StepConstrainerLookupSession |
getStepConstrainerLookupSession()
Gets the
OsidSession associated with the step
constrainer lookup service. |
StepConstrainerLookupSession |
getStepConstrainerLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer lookup service for the given office. |
StepConstrainerNotificationSession |
getStepConstrainerNotificationSession(StepConstrainerReceiver stepConstrainerReceiver)
Gets the
OsidSession associated with the step
constrainer notification service. |
StepConstrainerNotificationSession |
getStepConstrainerNotificationSessionForOffice(StepConstrainerReceiver stepConstrainerReceiver,
Id officeId)
Gets the
OsidSession associated with the step
constrainer notification service for the given office. |
StepConstrainerOfficeAssignmentSession |
getStepConstrainerOfficeAssignmentSession()
Gets the
OsidSession associated with assigning step
constrainer to office. |
StepConstrainerOfficeSession |
getStepConstrainerOfficeSession()
Gets the
OsidSession to lookup step constrainer/office
mappings for step constrainers. |
StepConstrainerQuerySession |
getStepConstrainerQuerySession()
Gets the
OsidSession associated with the step
constrainer query service. |
StepConstrainerQuerySession |
getStepConstrainerQuerySessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer query service for the given office. |
StepConstrainerRuleApplicationSession |
getStepConstrainerRuleApplicationSession()
Gets the
OsidSession associated with the step
constrainer assignment service to apply to steps. |
StepConstrainerRuleApplicationSession |
getStepConstrainerRuleApplicationSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer assignment service for the given office to apply to steps. |
StepConstrainerRuleLookupSession |
getStepConstrainerRuleLookupSession()
Gets the
OsidSession associated with the step
constrainer mapping lookup service for looking up the rules applied to
a step. |
StepConstrainerRuleLookupSession |
getStepConstrainerRuleLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer mapping lookup service for the given office for looking up
rules applied to a step. |
StepConstrainerSearchSession |
getStepConstrainerSearchSession()
Gets the
OsidSession associated with the step
constrainer search service. |
StepConstrainerSearchSession |
getStepConstrainerSearchSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step
constrainer earch service for the given office. |
StepConstrainerSmartOfficeSession |
getStepConstrainerSmartOfficeSession(Id officeId)
Gets the
OsidSession to manage step constrainer smart
office. |
StepProcessorAdminSession |
getStepProcessorAdminSession()
Gets the
OsidSession associated with the step processor
administration service. |
StepProcessorAdminSession |
getStepProcessorAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
administration service for the given office. |
StepProcessorEnablerAdminSession |
getStepProcessorEnablerAdminSession()
Gets the
OsidSession associated with the step processor
enabler administration service. |
StepProcessorEnablerAdminSession |
getStepProcessorEnablerAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
enabler administration service for the given office. |
StepProcessorEnablerLookupSession |
getStepProcessorEnablerLookupSession()
Gets the
OsidSession associated with the step processor
enabler lookup service. |
StepProcessorEnablerLookupSession |
getStepProcessorEnablerLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
enabler lookup service for the given office. |
StepProcessorEnablerNotificationSession |
getStepProcessorEnablerNotificationSession(StepProcessorEnablerReceiver stepProcessorEnablerReceiver)
Gets the
OsidSession associated with the step processor
enabler notification service. |
StepProcessorEnablerNotificationSession |
getStepProcessorEnablerNotificationSessionForOffice(StepProcessorEnablerReceiver stepProcessorEnablerReceiver,
Id officeId)
Gets the
OsidSession associated with the step processor
enabler notification service for the given office. |
StepProcessorEnablerOfficeAssignmentSession |
getStepProcessorEnablerOfficeAssignmentSession()
Gets the
OsidSession associated with assigning step
processor enablers to office. |
StepProcessorEnablerOfficeSession |
getStepProcessorEnablerOfficeSession()
Gets the
OsidSession to lookup step processor
enabler/office mappings for step processor enablers. |
StepProcessorEnablerQuerySession |
getStepProcessorEnablerQuerySession()
Gets the
OsidSession associated with the step processor
enabler query service. |
StepProcessorEnablerQuerySession |
getStepProcessorEnablerQuerySessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
enabler query service for the given office. |
StepProcessorEnablerRuleApplicationSession |
getStepProcessorEnablerRuleApplicationSession()
Gets the
OsidSession associated with the step processor
enabler assignment service. |
StepProcessorEnablerRuleApplicationSession |
getStepProcessorEnablerRuleApplicationSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
enabler assignment service for the given office. |
StepProcessorEnablerRuleLookupSession |
getStepProcessorEnablerRuleLookupSession()
Gets the
OsidSession associated with the step processor
enabler mapping lookup service. |
StepProcessorEnablerRuleLookupSession |
getStepProcessorEnablerRuleLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
enabler mapping lookup service. |
StepProcessorEnablerSearchSession |
getStepProcessorEnablerSearchSession()
Gets the
OsidSession associated with the step processor
enabler search service. |
StepProcessorEnablerSearchSession |
getStepProcessorEnablerSearchSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
enablers earch service for the given office. |
StepProcessorEnablerSmartOfficeSession |
getStepProcessorEnablerSmartOfficeSession(Id officeId)
Gets the
OsidSession to manage step processor enabler
smart office. |
StepProcessorLookupSession |
getStepProcessorLookupSession()
Gets the
OsidSession associated with the step processor
lookup service. |
StepProcessorLookupSession |
getStepProcessorLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
lookup service for the given office. |
StepProcessorNotificationSession |
getStepProcessorNotificationSession(StepProcessorReceiver stepProcessorReceiver)
Gets the
OsidSession associated with the step processor
notification service. |
StepProcessorNotificationSession |
getStepProcessorNotificationSessionForOffice(StepProcessorReceiver stepProcessorReceiver,
Id officeId)
Gets the
OsidSession associated with the step processor
notification service for the given office. |
StepProcessorOfficeAssignmentSession |
getStepProcessorOfficeAssignmentSession()
Gets the
OsidSession associated with assigning step
processor to office. |
StepProcessorOfficeSession |
getStepProcessorOfficeSession()
Gets the
OsidSession to lookup step processor/office
mappings for step processors. |
StepProcessorQuerySession |
getStepProcessorQuerySession()
Gets the
OsidSession associated with the step processor
query service. |
StepProcessorQuerySession |
getStepProcessorQuerySessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
query service for the given office. |
StepProcessorRuleApplicationSession |
getStepProcessorRuleApplicationSession()
Gets the
OsidSession associated with the step processor
assignment service. |
StepProcessorRuleApplicationSession |
getStepProcessorRuleApplicationSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
assignment service for the given office. |
StepProcessorRuleLookupSession |
getStepProcessorRuleLookupSession()
Gets the
OsidSession associated with the step processor
mapping lookup service for looking up the rules applied to a step. |
StepProcessorRuleLookupSession |
getStepProcessorRuleLookupSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
mapping lookup service for the given office for looking up rules
applied to a step. |
StepProcessorSearchSession |
getStepProcessorSearchSession()
Gets the
OsidSession associated with the step processor
search service. |
StepProcessorSearchSession |
getStepProcessorSearchSessionForOffice(Id officeId)
Gets the
OsidSession associated with the step processor
earch service for the given office. |
StepProcessorSmartOfficeSession |
getStepProcessorSmartOfficeSession(Id officeId)
Gets the
OsidSession to manage step processor smart
office. |
changeBranch, initialize, rollbackService
close
getProcessEnablerRecordTypes, getProcessEnablerSearchRecordTypes, getStepConstrainerEnablerRecordTypes, getStepConstrainerEnablerSearchRecordTypes, getStepConstrainerRecordTypes, getStepConstrainerSearchRecordTypes, getStepProcessorEnablerRecordTypes, getStepProcessorEnablerSearchRecordTypes, getStepProcessorRecordTypes, getStepProcessorSearchRecordTypes, supportsProcessEnablerAdmin, supportsProcessEnablerLookup, supportsProcessEnablerNotification, supportsProcessEnablerOffice, supportsProcessEnablerOfficeAssignment, supportsProcessEnablerQuery, supportsProcessEnablerRecordType, supportsProcessEnablerRuleApplication, supportsProcessEnablerRuleLookup, supportsProcessEnablerSearch, supportsProcessEnablerSearchRecordType, supportsProcessEnablerSmartOffice, supportsStepConstrainerAdmin, supportsStepConstrainerEnablerAdmin, supportsStepConstrainerEnablerLookup, supportsStepConstrainerEnablerNotification, supportsStepConstrainerEnablerOffice, supportsStepConstrainerEnablerOfficeAssignment, supportsStepConstrainerEnablerQuery, supportsStepConstrainerEnablerRecordType, supportsStepConstrainerEnablerRuleApplication, supportsStepConstrainerEnablerRuleLookup, supportsStepConstrainerEnablerSearch, supportsStepConstrainerEnablerSearchRecordType, supportsStepConstrainerEnablerSmartOffice, supportsStepConstrainerLookup, supportsStepConstrainerNotification, supportsStepConstrainerOffice, supportsStepConstrainerOfficeAssignment, supportsStepConstrainerQuery, supportsStepConstrainerRecordType, supportsStepConstrainerRuleApplication, supportsStepConstrainerRuleLookup, supportsStepConstrainerSearch, supportsStepConstrainerSearchRecordType, supportsStepConstrainerSmartOffice, supportsStepProcessorAdmin, supportsStepProcessorEnablerAdmin, supportsStepProcessorEnablerLookup, supportsStepProcessorEnablerNotification, supportsStepProcessorEnablerOffice, supportsStepProcessorEnablerOfficeAssignment, supportsStepProcessorEnablerQuery, supportsStepProcessorEnablerRecordType, supportsStepProcessorEnablerRuleApplication, supportsStepProcessorEnablerRuleLookup, supportsStepProcessorEnablerSearch, supportsStepProcessorEnablerSearchRecordType, supportsStepProcessorEnablerSmartOffice, supportsStepProcessorLookup, supportsStepProcessorNotification, supportsStepProcessorOffice, supportsStepProcessorOfficeAssignment, supportsStepProcessorQuery, supportsStepProcessorRecordType, supportsStepProcessorRuleApplication, supportsStepProcessorRuleLookup, supportsStepProcessorSearch, supportsStepProcessorSearchRecordType, supportsStepProcessorSmartOffice, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
StepConstrainerLookupSession getStepConstrainerLookupSession() throws OperationFailedException
OsidSession
associated with the step
constrainer lookup service. StepConstrainerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerLookup()
is false
optional
- This method must be implemented if
supportsStepConstrainerLookup()
is true.
StepConstrainerLookupSession getStepConstrainerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer lookup service for the given office.officeId
- the Id
of the Office
StepConstrainerLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerLookup()
and
supportsVisibleFederation()
are true.
StepConstrainerQuerySession getStepConstrainerQuerySession() throws OperationFailedException
OsidSession
associated with the step
constrainer query service. StepConstrainerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerQuery()
is false
optional
- This method must be implemented if
supportsStepConstrainerQuery()
is true.
StepConstrainerQuerySession getStepConstrainerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer query service for the given office.officeId
- the Id
of the Office
StepConstrainerQuerySession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerQuery()
and
supportsVisibleFederation()
are true.
StepConstrainerSearchSession getStepConstrainerSearchSession() throws OperationFailedException
OsidSession
associated with the step
constrainer search service. StepConstrainerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerSearch()
is false
optional
- This method must be implemented if
supportsStepConstrainerSearch()
is true.
StepConstrainerSearchSession getStepConstrainerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer earch service for the given office.officeId
- the Id
of the Office
StepConstrainerSearchSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerSearch()
and
supportsVisibleFederation()
are true.
StepConstrainerAdminSession getStepConstrainerAdminSession() throws OperationFailedException
OsidSession
associated with the step
constrainer administration service. StepConstrainerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerAdmin()
is false
optional
- This method must be implemented if
supportsStepConstrainerAdmin()
is true.
StepConstrainerAdminSession getStepConstrainerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer administration service for the given office.officeId
- the Id
of the Office
StepConstrainerAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerAdmin()
and
supportsVisibleFederation()
are true.
StepConstrainerNotificationSession getStepConstrainerNotificationSession(StepConstrainerReceiver stepConstrainerReceiver) throws OperationFailedException
OsidSession
associated with the step
constrainer notification service.stepConstrainerReceiver
- the notification callback StepConstrainerNotificationSession
NullArgumentException
- stepConstrainerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerNotification()
is false
optional
- This method must be implemented if
supportsStepConstrainerNotification()
is
true.
StepConstrainerNotificationSession getStepConstrainerNotificationSessionForOffice(StepConstrainerReceiver stepConstrainerReceiver, Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer notification service for the given office.stepConstrainerReceiver
- the notification callbackofficeId
- the Id
of the Office
StepConstrainerNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- stepConstrainerReceiver
or officeId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerNotification()
and
supportsVisibleFederation()
are true.
StepConstrainerOfficeSession getStepConstrainerOfficeSession() throws OperationFailedException
OsidSession
to lookup step constrainer/office
mappings for step constrainers. StepConstrainerOfficeSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerOffice()
is false
optional
- This method must be implemented if
supportsStepConstrainerOffice()
is true.
StepConstrainerOfficeAssignmentSession getStepConstrainerOfficeAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning step
constrainer to office. StepConstrainerOfficeAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerOfficeAssignment()
is
false
optional
- This method must be implemented if
supportsStepConstrainerOfficeAssignment()
is
true.
StepConstrainerSmartOfficeSession getStepConstrainerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
to manage step constrainer smart
office.officeId
- the Id
of the Office
StepConstrainerSmartOfficeSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerSmartOffice()
is false
optional
- This method must be implemented if
supportsStepConstrainerSmartOffice()
is
true.
StepConstrainerRuleLookupSession getStepConstrainerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the step
constrainer mapping lookup service for looking up the rules applied to
a step. StepConstrainerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerRuleLookup()
is false
optional
- This method must be implemented if
supportsStepConstrainerRuleLookup()
is
true.
StepConstrainerRuleLookupSession getStepConstrainerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer mapping lookup service for the given office for looking up
rules applied to a step.officeId
- the Id
of the Office
StepConstrainerRuleLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerRuleLookup()
and
supportsVisibleFederation()
are true.
StepConstrainerRuleApplicationSession getStepConstrainerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the step
constrainer assignment service to apply to steps. StepConstrainerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerRuleApplication()
is
false
optional
- This method must be implemented if
supportsStepConstrainerRuleApplication()
is
true.
StepConstrainerRuleApplicationSession getStepConstrainerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer assignment service for the given office to apply to steps.officeId
- the Id
of the Office
StepConstrainerRuleApplicationSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerRuleApplication()
and
supportsVisibleFederation()
are
true.
StepConstrainerEnablerLookupSession getStepConstrainerEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the step
constrainer enabler lookup service. StepConstrainerEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerLookup()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerLookup()
is
true.
StepConstrainerEnablerLookupSession getStepConstrainerEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enabler lookup service for the given office.officeId
- the Id
of the Office
StepConstrainerEnablerLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerLookup()
and
supportsVisibleFederation()
are true.
StepConstrainerEnablerQuerySession getStepConstrainerEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the step
constrainer enabler query service. StepConstrainerEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerQuery()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerQuery()
is
true.
StepConstrainerEnablerQuerySession getStepConstrainerEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enabler query service for the given office.officeId
- the Id
of the Office
StepConstrainerEnablerQuerySession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerQuery()
and
supportsVisibleFederation()
are true.
StepConstrainerEnablerSearchSession getStepConstrainerEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the step
constrainer enabler search service. StepConstrainerEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerSearch()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerSearch()
is
true.
StepConstrainerEnablerSearchSession getStepConstrainerEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enablers earch service for the given office.officeId
- the Id
of the Office
StepConstrainerEnablerSearchSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerSearch()
and
supportsVisibleFederation()
are true.
StepConstrainerEnablerAdminSession getStepConstrainerEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the step
constrainer enabler administration service. StepConstrainerEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerAdmin()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerAdmin()
is
true.
StepConstrainerEnablerAdminSession getStepConstrainerEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enabler administration service for the given office.officeId
- the Id
of the Office
StepConstrainerEnablerAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerAdmin()
and
supportsVisibleFederation()
are true.
StepConstrainerEnablerNotificationSession getStepConstrainerEnablerNotificationSession(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver) throws OperationFailedException
OsidSession
associated with the step
constrainer enabler notification service.stepConstrainerEnablerReceiver
- the notification callback StepConstrainerEnablerNotificationSession
NullArgumentException
-
stepConstrainerEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerNotification()
is
false
optional
- This method must be implemented if
supportsStepConstrainerEnablerNotification()
is
true.
StepConstrainerEnablerNotificationSession getStepConstrainerEnablerNotificationSessionForOffice(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enabler notification service for the given office.stepConstrainerEnablerReceiver
- the notification callbackofficeId
- the Id
of the Office
StepConstrainerEnablerNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
-
stepConstrainerEnablerReceiver
or officeId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerNotification()
and
supportsVisibleFederation()
are
true.
StepConstrainerEnablerOfficeSession getStepConstrainerEnablerOfficeSession() throws OperationFailedException
OsidSession
to lookup step constrainer
enabler/office mappings for step constrainer enablers. StepConstrainerEnablerOfficeSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerOffice()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerOffice()
is
true.
StepConstrainerEnablerOfficeAssignmentSession getStepConstrainerEnablerOfficeAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning step
constrainer enablers to office. StepConstrainerEnablerOfficeAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerOfficeAssignment()
is
false
optional
- This method must be implemented if
supportsStepConstrainerEnablerOfficeAssignment()
is true.
StepConstrainerEnablerSmartOfficeSession getStepConstrainerEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
to manage step constrainer enabler
smart office.officeId
- the Id
of the Office
StepConstrainerEnablerSmartOfficeSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerSmartOffice()
is
false
optional
- This method must be implemented if
supportsStepConstrainerEnablerSmartOffice()
is
true.
StepConstrainerEnablerRuleLookupSession getStepConstrainerEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the step
constrainer enabler mapping lookup service. StepConstrainerEnablerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsStepConstrainerEnablerRuleLookup()
is
true.
StepConstrainerEnablerRuleLookupSession getStepConstrainerEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enabler mapping lookup service for the given office.officeId
- the Id
of the Office
StepConstrainerEnablerRuleLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerRuleLookup()
and
supportsVisibleFederation()
are
true.
StepConstrainerEnablerRuleApplicationSession getStepConstrainerEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the step
constrainer enabler assignment service. StepConstrainerEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsStepConstrainerEnablerRuleApplication()
is
true.
StepConstrainerEnablerRuleApplicationSession getStepConstrainerEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
constrainer enabler assignment service for the given office.officeId
- the Id
of the Office
StepConstrainerEnablerRuleApplicationSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepConstrainerEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepConstrainerEnablerRuleApplication()
and supportsVisibleFederation()
are
true.
StepProcessorLookupSession getStepProcessorLookupSession() throws OperationFailedException
OsidSession
associated with the step processor
lookup service. StepProcessorLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorLookup()
is false
optional
- This method must be implemented if
supportsStepProcessorLookup()
is true.
StepProcessorLookupSession getStepProcessorLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
lookup service for the given office.officeId
- the Id
of the Office
StepProcessorLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorLookup()
and
supportsVisibleFederation()
are true.
StepProcessorQuerySession getStepProcessorQuerySession() throws OperationFailedException
OsidSession
associated with the step processor
query service. StepProcessorQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorQuery()
is false
optional
- This method must be implemented if
supportsStepProcessorQuery()
is true.
StepProcessorQuerySession getStepProcessorQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
query service for the given office.officeId
- the Id
of the Office
StepProcessorQuerySession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorQuery()
and
supportsVisibleFederation()
are true.
StepProcessorSearchSession getStepProcessorSearchSession() throws OperationFailedException
OsidSession
associated with the step processor
search service. StepProcessorSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorSearch()
is false
optional
- This method must be implemented if
supportsStepProcessorSearch()
is true.
StepProcessorSearchSession getStepProcessorSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
earch service for the given office.officeId
- the Id
of the Office
StepProcessorSearchSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorSearch()
and
supportsVisibleFederation()
are true.
StepProcessorAdminSession getStepProcessorAdminSession() throws OperationFailedException
OsidSession
associated with the step processor
administration service. StepProcessorAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorAdmin()
is false
optional
- This method must be implemented if
supportsStepProcessorAdmin()
is true.
StepProcessorAdminSession getStepProcessorAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
administration service for the given office.officeId
- the Id
of the Office
StepProcessorAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorAdmin()
and
supportsVisibleFederation()
are true.
StepProcessorNotificationSession getStepProcessorNotificationSession(StepProcessorReceiver stepProcessorReceiver) throws OperationFailedException
OsidSession
associated with the step processor
notification service.stepProcessorReceiver
- the notification callback StepProcessorNotificationSession
NullArgumentException
- stepProcessorReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorNotification()
is false
optional
- This method must be implemented if
supportsStepProcessorNotification()
is
true.
StepProcessorNotificationSession getStepProcessorNotificationSessionForOffice(StepProcessorReceiver stepProcessorReceiver, Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
notification service for the given office.stepProcessorReceiver
- the notification callbackofficeId
- the Id
of the Office
StepProcessorNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- stepProcessorReceiver
or officeId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorNotification()
and
supportsVisibleFederation()
are true.
StepProcessorOfficeSession getStepProcessorOfficeSession() throws OperationFailedException
OsidSession
to lookup step processor/office
mappings for step processors. StepProcessorOfficeSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorOffice()
is false
optional
- This method must be implemented if
supportsStepProcessorOffice()
is true.
StepProcessorOfficeAssignmentSession getStepProcessorOfficeAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning step
processor to office. StepProcessorOfficeAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorOfficeAssignment()
is
false
optional
- This method must be implemented if
supportsStepProcessorOfficeAssignment()
is
true.
StepProcessorSmartOfficeSession getStepProcessorSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
to manage step processor smart
office.officeId
- the Id
of the Office
StepProcessorSmartOfficeSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorSmartOffice()
is false
optional
- This method must be implemented if
supportsStepProcessorSmartOffice()
is true.
StepProcessorRuleLookupSession getStepProcessorRuleLookupSession() throws OperationFailedException
OsidSession
associated with the step processor
mapping lookup service for looking up the rules applied to a step. StepProcessorRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorRuleLookup()
is false
optional
- This method must be implemented if
supportsStepProcessorRuleLookup()
is true.
StepProcessorRuleLookupSession getStepProcessorRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
mapping lookup service for the given office for looking up rules
applied to a step.officeId
- the Id
of the Office
StepProcessorRuleLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorRuleLookup()
and
supportsVisibleFederation()
are true.
StepProcessorRuleApplicationSession getStepProcessorRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the step processor
assignment service. StepProcessorRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorRuleApplication()
is false
optional
- This method must be implemented if
supportsStepProcessorRuleApplication()
is
true.
StepProcessorRuleApplicationSession getStepProcessorRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
assignment service for the given office.officeId
- the Id
of the Office
StepProcessorRuleApplicationSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorRuleApplication()
and
supportsVisibleFederation()
are true.
StepProcessorEnablerLookupSession getStepProcessorEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the step processor
enabler lookup service. StepProcessorEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerLookup()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerLookup()
is
true.
StepProcessorEnablerLookupSession getStepProcessorEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enabler lookup service for the given office.officeId
- the Id
of the Office
StepProcessorEnablerLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerLookup()
and
supportsVisibleFederation()
are true.
StepProcessorEnablerQuerySession getStepProcessorEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the step processor
enabler query service. StepProcessorEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerQuery()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerQuery()
is
true.
StepProcessorEnablerQuerySession getStepProcessorEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enabler query service for the given office.officeId
- the Id
of the Office
StepProcessorEnablerQuerySession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerQuery()
and
supportsVisibleFederation()
are true.
StepProcessorEnablerSearchSession getStepProcessorEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the step processor
enabler search service. StepProcessorEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerSearch()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerSearch()
is
true.
StepProcessorEnablerSearchSession getStepProcessorEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enablers earch service for the given office.officeId
- the Id
of the Office
StepProcessorEnablerSearchSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerSearch()
and
supportsVisibleFederation()
are true.
StepProcessorEnablerAdminSession getStepProcessorEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the step processor
enabler administration service. StepProcessorEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerAdmin()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerAdmin()
is
true.
StepProcessorEnablerAdminSession getStepProcessorEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enabler administration service for the given office.officeId
- the Id
of the Office
StepProcessorEnablerAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerAdmin()
and
supportsVisibleFederation()
are true.
StepProcessorEnablerNotificationSession getStepProcessorEnablerNotificationSession(StepProcessorEnablerReceiver stepProcessorEnablerReceiver) throws OperationFailedException
OsidSession
associated with the step processor
enabler notification service.stepProcessorEnablerReceiver
- the notification callback StepProcessorEnablerNotificationSession
NullArgumentException
-
stepProcessorEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerNotification()
is
false
optional
- This method must be implemented if
supportsStepProcessorEnablerNotification()
is
true.
StepProcessorEnablerNotificationSession getStepProcessorEnablerNotificationSessionForOffice(StepProcessorEnablerReceiver stepProcessorEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enabler notification service for the given office.stepProcessorEnablerReceiver
- the notification callbackofficeId
- the Id
of the Office
StepProcessorEnablerNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
-
stepProcessorEnablerReceiver
or officeId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerNotification()
and
supportsVisibleFederation()
are
true.
StepProcessorEnablerOfficeSession getStepProcessorEnablerOfficeSession() throws OperationFailedException
OsidSession
to lookup step processor
enabler/office mappings for step processor enablers. StepProcessorEnablerOfficeSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerOffice()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerOffice()
is
true.
StepProcessorEnablerOfficeAssignmentSession getStepProcessorEnablerOfficeAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning step
processor enablers to office. StepProcessorEnablerOfficeAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerOfficeAssignment()
is
false
optional
- This method must be implemented if
supportsStepProcessorEnablerOfficeAssignment()
is
true.
StepProcessorEnablerSmartOfficeSession getStepProcessorEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
to manage step processor enabler
smart office.officeId
- the Id
of the Office
StepProcessorEnablerSmartOfficeSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerSmartOffice()
is
false
optional
- This method must be implemented if
supportsStepProcessorEnablerSmartOffice()
is
true.
StepProcessorEnablerRuleLookupSession getStepProcessorEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the step processor
enabler mapping lookup service. StepProcessorEnablerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerRuleLookup()
is
false
optional
- This method must be implemented if
supportsStepProcessorEnablerRuleLookup()
is
true.
StepProcessorEnablerRuleLookupSession getStepProcessorEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enabler mapping lookup service.officeId
- the Id
of the Office
StepProcessorEnablerRuleLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerRuleLookup()
and
supportsVisibleFederation()
are
true.
StepProcessorEnablerRuleApplicationSession getStepProcessorEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the step processor
enabler assignment service. StepProcessorEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsStepProcessorEnablerRuleApplication()
is
true.
StepProcessorEnablerRuleApplicationSession getStepProcessorEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the step processor
enabler assignment service for the given office.officeId
- the Id
of the Office
StepProcessorEnablerRuleApplicationSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepProcessorEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepProcessorEnablerRuleApplication()
and
supportsVisibleFederation()
are
true.
ProcessEnablerLookupSession getProcessEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the process
enabler lookup service. ProcessEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerLookup()
is false
optional
- This method must be implemented if
supportsProcessEnablerLookup()
is true.
ProcessEnablerLookupSession getProcessEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler lookup service for the given office.officeId
- the Id
of the Office
ProcessEnablerLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerLookup()
and
supportsVisibleFederation()
are true.
ProcessEnablerQuerySession getProcessEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the process
enabler query service. ProcessEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerQuery()
is false
optional
- This method must be implemented if
supportsProcessEnablerQuery()
is true.
ProcessEnablerQuerySession getProcessEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler query service for the given office.officeId
- the Id
of the Office
ProcessEnablerQuerySession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerQuery()
and
supportsVisibleFederation()
are true.
ProcessEnablerSearchSession getProcessEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the process
enabler search service. ProcessEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerSearch()
is false
optional
- This method must be implemented if
supportsProcessEnablerSearch()
is true.
ProcessEnablerSearchSession getProcessEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler earch service for the given office.officeId
- the Id
of the Office
ProcessEnablerSearchSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerSearch()
and
supportsVisibleFederation()
are true.
ProcessEnablerAdminSession getProcessEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the process
enabler administration service. ProcessEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerAdmin()
is false
optional
- This method must be implemented if
supportsProcessEnablerAdmin()
is true.
ProcessEnablerAdminSession getProcessEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler administration service for the given office.officeId
- the Id
of the Office
ProcessEnablerAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerAdmin()
and
supportsVisibleFederation()
are true.
ProcessEnablerNotificationSession getProcessEnablerNotificationSession(ProcessEnablerReceiver processEnablerReceiver) throws OperationFailedException
OsidSession
associated with the process
enabler notification service.processEnablerReceiver
- the notification callback ProcessEnablerNotificationSession
NullArgumentException
- processEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerNotification()
is false
optional
- This method must be implemented if
supportsProcessEnablerNotification()
is
true.
ProcessEnablerNotificationSession getProcessEnablerNotificationSessionForOffice(ProcessEnablerReceiver processEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler notification service for the given office.processEnablerReceiver
- the notification callbackofficeId
- the Id
of the Office
ProcessEnablerNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- processEnablerReceiver
or officeId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerNotification()
and
supportsVisibleFederation()
are true.
ProcessEnablerOfficeSession getProcessEnablerOfficeSession() throws OperationFailedException
OsidSession
to lookup process enabler/office
mappings for process enablers. ProcessEnablerOfficeSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerOffice()
is false
optional
- This method must be implemented if
supportsProcessEnablerOffice()
is true.
ProcessEnablerOfficeAssignmentSession getProcessEnablerOfficeAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning process
enabler to office. ProcessEnablerOfficeAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerOfficeAssignment()
is
false
optional
- This method must be implemented if
supportsProcessEnablerOfficeAssignment()
is
true.
ProcessEnablerSmartOfficeSession getProcessEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
to manage process enabler smart
office.officeId
- the Id
of the Office
ProcessEnablerSmartOfficeSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerSmartOffice()
is false
optional
- This method must be implemented if
supportsProcessEnablerSmartOffice()
is
true.
ProcessEnablerRuleLookupSession getProcessEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the process
enabler mapping lookup service for looking up the rules applied to the
process. ProcessEnablerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerRuleLookup()
is false
optional
- This method must be implemented if
supportsProcessEnablerRuleLookup()
is true.
ProcessEnablerRuleLookupSession getProcessEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler mapping lookup service for the given office for looking up
rules applied to a process.officeId
- the Id
of the Office
ProcessEnablerRuleLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerRuleLookup()
and
supportsVisibleFederation()
are true.
ProcessEnablerRuleApplicationSession getProcessEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the process
enabler assignment service to apply to processs. ProcessEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsProcessEnablerRuleApplication()
is
true.
ProcessEnablerRuleApplicationSession getProcessEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
enabler assignment service for the given office to apply to processs.officeId
- the Id
of the Office
ProcessEnablerRuleApplicationSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessEnablerRuleApplication()
and
supportsVisibleFederation()
are true.