public interface WorkflowProxyManager extends OsidProxyManager, WorkflowProfile
The workflow proxy manager provides access to rules sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager pass a Proxy
for passing
information from server environments. The sessions included in this
manager are:
ProcessLookupSession:
a session to retrieve
processs ProcessQuerySession:
a session to query for
processs ProcessSearchSession:
a session to search for
processs ProcessAdminSession:
a session to create and
delete processs ProcessNotificationSession:
a session to receive
notifications pertaining to process changes ProcessOfficeSession:
a session to looking
mappings of process to offices ProcessOfficeAssignmentSession:
a session to
manage process to office workflows ProcessSmartOfficeSession:
a session to manage
dynamic offices of processs StepLookupSession:
a session to retrieve steps
StepQuerySession:
a session to query for steps
StepSearchSession:
a session to search for steps
StepAdminSession:
a session to create and delete
steps StepNotificationSession:
a session to receive
notifications pertaining to step changes StepOfficeSession:
a session to look up step
office mappings StepOfficeAssignmentSession:
a session to manage
steps to office mappings StepSmartOfficeSession:
a session to manage
dynamic offices of stepss WorkLookupSession:
a session to retrieve work
WorkQuerySession:
a session to query for work
WorkSearchSession:
a session to search for work
WorkAdminSession:
a session to create and delete
work WorkNotificationSession:
a session to receive
notifications pertaining to work changes WorkOfficeSession:
a session to look up work
office mappings WorkOfficeAssignmentSession:
a session to manage
availability to office mappings WorkSmartOfficeSession:
a session to manage
dynamic offices of work WorkflowSession:
a session to examine work in a
process WorkflowInitiationSession:
a session to start work
through a process WorkflowManagementSession:
a session to enable and
disable work in a process ManualWorkflowSession:
a session to manuall assign
work to steps in a process WorkflowLogSession:
a session to look up changes
in a workflow WorkflowEventNotificationSession:
a session to
receive notifications of workflow changes OfficeLookupSession:
a session to retrieve offices
OfficeQuerySession:
a session to search for
offices OfficeSearchSession:
a session to search for
offices OfficeAdminSession:
a session to create and delete
offices OfficeNotificationSession:
a session to receive
notifications pertaining to office changes OfficeHierarchySession:
a session to traverse a
hierarchy of office OfficeHierarchyDesignSession:
a session to manage
a office hierarchy Modifier and Type | Method and Description |
---|---|
ManualWorkflowSession |
getManualWorkflowSession(Proxy proxy)
Gets the
OsidSession for a manual workflow service. |
ManualWorkflowSession |
getManualWorkflowSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession for a manual workflow service for
the given office. |
OfficeAdminSession |
getOfficeAdminSession(Proxy proxy)
Gets the
OsidSession associated with the office
administrative service. |
OfficeHierarchyDesignSession |
getOfficeHierarchyDesignSession(Proxy proxy)
Gets the
OsidSession associated with the office
hierarchy design service. |
OfficeHierarchySession |
getOfficeHierarchySession(Proxy proxy)
Gets the
OsidSession associated with the office
hierarchy service. |
OfficeLookupSession |
getOfficeLookupSession(Proxy proxy)
Gets the
OsidSession associated with the office lookup
service. |
OfficeNotificationSession |
getOfficeNotificationSession(OfficeReceiver officeReceiver,
Proxy proxy)
Gets the
OsidSession associated with the office
notification service. |
OfficeQuerySession |
getOfficeQuerySession(Proxy proxy)
Gets the
OsidSession associated with the office query
service. |
OfficeSearchSession |
getOfficeSearchSession(Proxy proxy)
Gets the
OsidSession associated with the office search
service. |
ProcessAdminSession |
getProcessAdminSession(Proxy proxy)
Gets the
OsidSession associated with the process
administration service. |
ProcessAdminSession |
getProcessAdminSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the process
administration service for the given office. |
ProcessLookupSession |
getProcessLookupSession(Proxy proxy)
Gets the
OsidSession associated with the process lookup
service. |
ProcessLookupSession |
getProcessLookupSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the process lookup
service for the given office. |
ProcessNotificationSession |
getProcessNotificationSession(ProcessReceiver processReceiver,
Proxy proxy)
Gets the
OsidSession associated with the process
notification service. |
ProcessNotificationSession |
getProcessNotificationSessionForOffice(ProcessReceiver processReceiver,
Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the process
notification service for the given office. |
ProcessOfficeAssignmentSession |
getProcessOfficeAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning process
to offices. |
ProcessOfficeSession |
getProcessOfficeSession(Proxy proxy)
Gets the
OsidSession to lookup process/office mappings. |
ProcessQuerySession |
getProcessQuerySession(Proxy proxy)
Gets the
OsidSession associated with the process query
service. |
ProcessQuerySession |
getProcessQuerySessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the process query
service for the given office. |
ProcessSearchSession |
getProcessSearchSession(Proxy proxy)
Gets the
OsidSession associated with the process search
service. |
ProcessSearchSession |
getProcessSearchSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the process search
service for the given office. |
ProcessSmartOfficeSession |
getProcessSmartOfficeSession(Id officeId,
Proxy proxy)
Gets the
OsidSession to manage process smart offices. |
StepAdminSession |
getStepAdminSession(Proxy proxy)
Gets the
OsidSession associated with the step
administration service. |
StepAdminSession |
getStepAdminSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the step
administration service for the given office. |
StepLookupSession |
getStepLookupSession(Proxy proxy)
Gets the
OsidSession associated with the step lookup
service. |
StepLookupSession |
getStepLookupSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the step lookup
service for the given office. |
StepNotificationSession |
getStepNotificationSession(StepReceiver stepReceiver,
Proxy proxy)
Gets the
OsidSession associated with the step
notification service. |
StepNotificationSession |
getStepNotificationSessionForOffice(StepReceiver stepReceiver,
Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the step
notification service for the given office. |
StepOfficeAssignmentSession |
getStepOfficeAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning steps to
offices. |
StepOfficeSession |
getStepOfficeSession(Proxy proxy)
Gets the
OsidSession to lookup step/office mappings. |
StepQuerySession |
getStepQuerySession(Proxy proxy)
Gets the
OsidSession associated with the step query
service. |
StepQuerySession |
getStepQuerySessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the step query
service for the given office. |
StepSearchSession |
getStepSearchSession(Proxy proxy)
Gets the
OsidSession associated with the step search
service. |
StepSearchSession |
getStepSearchSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the step search
service for the given office. |
StepOfficeSession |
getStepSmartOfficeSession(Id officeId,
Proxy proxy)
Gets the
OsidSession to manage step smart offices. |
WorkAdminSession |
getWorkAdminSession(Proxy proxy)
Gets the
OsidSession associated with the work
administration service. |
WorkAdminSession |
getWorkAdminSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the work
administration service for the given office. |
WorkflowBatchProxyManager |
getWorkflowBatchProxyManager()
Gets a
WorkflowBatchProxyManager. |
WorkflowEventLookupSession |
getWorkflowEventLookupSession(Proxy proxy)
Gets the
OsidSession for a workflow event lookup
service. |
WorkflowEventLookupSession |
getWorkflowEventLookupSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession for a workflow event lookup
service for the given office. |
WorkflowEventNotificationSession |
getWorkflowEventNotificationSession(WorkflowEventReceiver workflowEventReceiver,
Proxy proxy)
Gets the
OsidSession associated with the workflow event
notification service. |
WorkflowEventNotificationSession |
getWorkflowEventNotificationSessionForOffice(WorkflowEventReceiver workflowEventReceiver,
Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the workflow event
notification service for the given office. |
WorkflowInitiationSession |
getWorkflowInitiationSession(Proxy proxy)
Gets the
OsidSession for a workflow initiation service. |
WorkflowInitiationSession |
getWorkflowInitiationSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession for a workflow initiation service
for the given office. |
WorkflowManagementSession |
getWorkflowManagementSession(Proxy proxy)
Gets the
OsidSession for a workflow management service. |
WorkflowManagementSession |
getWorkflowManagementSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession for a workflow management service
for the given office. |
WorkflowRulesProxyManager |
getWorkflowRulesProxyManager()
Gets a
WorkflowRulesProxyManager . |
WorkflowSession |
getWorkflowSession(Proxy proxy)
Gets the
OsidSession for a workflow service. |
WorkflowSession |
getWorkflowSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession for a workflow service for the
given office. |
WorkLookupSession |
getWorkLookupSession(Proxy proxy)
Gets the
OsidSession associated with the work lookup
service. |
WorkLookupSession |
getWorkLookupSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the work lookup
service for the given office. |
WorkNotificationSession |
getWorkNotificationSession(WorkReceiver workReceiver,
Proxy proxy)
Gets the
OsidSession associated with the work
notification service. |
WorkNotificationSession |
getWorkNotificationSessionForOffice(WorkReceiver workReceiver,
Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the work
notification service for the given office. |
WorkOfficeAssignmentSession |
getWorkOfficeAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning work to
offices. |
WorkOfficeSession |
getWorkOfficeSession(Proxy proxy)
Gets the
OsidSession to lookup work/office mappings. |
WorkQuerySession |
getWorkQuerySession(Proxy proxy)
Gets the
OsidSession associated with the work query
service. |
WorkQuerySession |
getWorkQuerySessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the work query
service for the given office. |
WorkSearchSession |
getWorkSearchSession(Proxy proxy)
Gets the
OsidSession associated with the work search
service. |
WorkSearchSession |
getWorkSearchSessionForOffice(Id officeId,
Proxy proxy)
Gets the
OsidSession associated with the work search
service for the given office. |
WorkSmartOfficeSession |
getWorkSmartOfficeSession(Id officeId,
Proxy proxy)
Gets the
OsidSession to manage work smart offices. |
changeBranch, initialize, rollbackService
close
getOfficeRecordTypes, getOfficeSearchRecordTypes, getProcessRecordTypes, getProcessSearchRecordTypes, getStepRecordTypes, getStepSearchRecordTypes, getWorkflowEventRecordTypes, getWorkRecordTypes, getWorkSearchRecordTypes, supportsManualWorkflow, supportsOfficeAdmin, supportsOfficeHierarchy, supportsOfficeHierarchyDesign, supportsOfficeLookup, supportsOfficeNotification, supportsOfficeQuery, supportsOfficeRecordType, supportsOfficeSearch, supportsOfficeSearchRecordType, supportsProcessAdmin, supportsProcessLookup, supportsProcessNotification, supportsProcessOffice, supportsProcessOfficeAssignment, supportsProcessQuery, supportsProcessRecordType, supportsProcessSearch, supportsProcessSearchRecordType, supportsProcessSmartOffice, supportsStepAdmin, supportsStepLookup, supportsStepNotification, supportsStepOffice, supportsStepOfficeAssignment, supportsStepQuery, supportsStepRecordType, supportsStepSearch, supportsStepSearchRecordType, supportsStepSmartOffice, supportsVisibleFederation, supportsWorkAdmin, supportsWorkflow, supportsWorkflowBatch, supportsWorkflowEventLookup, supportsWorkflowEventNotification, supportsWorkflowEventRecordType, supportsWorkflowInitiation, supportsWorkflowManagement, supportsWorkflowRules, supportsWorkLookup, supportsWorkNotification, supportsWorkOffice, supportsWorkOfficeAssignment, supportsWorkQuery, supportsWorkRecordType, supportsWorkSearch, supportsWorkSearchRecordType, supportsWorkSmartOffice
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProcessLookupSession getProcessLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the process lookup
service.proxy
- a proxy ProcessLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessLookup()
is false
optional
- This method must be implemented if
supportsProcessLookup()
is true.
ProcessLookupSession getProcessLookupSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the process lookup
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy ProcessLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProcessLookup()
and
supportsVisibleFederation()
are true
ProcessQuerySession getProcessQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the process query
service.proxy
- a proxy ProcessQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessQuery()
is false
optional
- This method must be implemented if
supportsProcessQuery()
is true.
ProcessQuerySession getProcessQuerySessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the process query
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy ProcessQuerySession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProcessQuery()
and
supportsVisibleFederation()
are true
ProcessSearchSession getProcessSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the process search
service.proxy
- a proxy ProcessSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessSearch()
is false
optional
- This method must be implemented if
supportsProcessSearch()
is true.
ProcessSearchSession getProcessSearchSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the process search
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy ProcessSearchSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProcessSearch()
and
supportsVisibleFederation()
are true
ProcessAdminSession getProcessAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the process
administration service.proxy
- a proxy ProcessAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessAdmin()
is false
optional
- This method must be implemented if
supportsProcessAdmin()
is true.
ProcessAdminSession getProcessAdminSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
administration service for the given office.officeId
- the Id
of the Office
proxy
- a proxy ProcessAdminSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsProcessAdmin()
and
supportsVisibleFederation()
are true
ProcessNotificationSession getProcessNotificationSession(ProcessReceiver processReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the process
notification service.processReceiver
- the notification callbackproxy
- a proxy ProcessNotificationSession
NullArgumentException
- processReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessNotification()
is false
optional
- This method must be implemented if
supportsProcessNotification()
is true.
ProcessNotificationSession getProcessNotificationSessionForOffice(ProcessReceiver processReceiver, Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the process
notification service for the given office.processReceiver
- the notification callbackofficeId
- the Id
of the Office
proxy
- a proxy ProcessNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- processReceiver,
officeId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessNotification()
and
supportsVisibleFederation()
are true
ProcessOfficeSession getProcessOfficeSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup process/office mappings.proxy
- a proxy ProcessOfficeSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsProcessOffice()
is false
optional
- This method must be implemented if
supportsProcessOffice()
is true.
ProcessOfficeAssignmentSession getProcessOfficeAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning process
to offices.proxy
- a proxy ProcessOfficeAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessOfficeAssignment()
is false
optional
- This method must be implemented if
supportsProcessOfficeAssignment()
is true.
ProcessSmartOfficeSession getProcessSmartOfficeSession(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage process smart offices.officeId
- the Id
of the Office
proxy
- a proxy ProcessSmartOfficeSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessSmartOffice()
is false
optional
- This method must be implemented if
supportsProcessSmartOffice()
is true.
StepLookupSession getStepLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the step lookup
service.proxy
- a proxy StepLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepLookup()
is false
optional
- This method must be implemented if
supportsStepLookup()
is true.
StepLookupSession getStepLookupSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the step lookup
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy StepLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStepLookup()
and
supportsVisibleFederation()
are true
StepQuerySession getStepQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the step query
service.proxy
- a proxy StepQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepQuery()
is false
optional
- This method must be implemented if
supportsStepQuery()
is true.
StepQuerySession getStepQuerySessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the step query
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy StepQuerySession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStepQuery()
and
supportsVisibleFederation()
are true
StepSearchSession getStepSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the step search
service.proxy
- a proxy StepSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepSearch()
is false
optional
- This method must be implemented if
supportsStepSearch()
is true.
StepSearchSession getStepSearchSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the step search
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy StepSearchSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStepSearch()
and
supportsVisibleFederation()
are true
StepAdminSession getStepAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the step
administration service.proxy
- a proxy StepAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepAdmin()
is false
optional
- This method must be implemented if
supportsStepAdmin()
is true.
StepAdminSession getStepAdminSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
administration service for the given office.officeId
- the Id
of the Office
proxy
- a proxy StepAdminSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsStepAdmin()
and
supportsVisibleFederation()
are true
StepNotificationSession getStepNotificationSession(StepReceiver stepReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the step
notification service.stepReceiver
- the notification callbackproxy
- a proxy StepNotificationSession
NullArgumentException
- stepReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepNotification()
is false
optional
- This method must be implemented if
supportsStepNotification()
is true.
StepNotificationSession getStepNotificationSessionForOffice(StepReceiver stepReceiver, Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the step
notification service for the given office.stepReceiver
- the notification callbackofficeId
- the Id
of the Office
proxy
- a proxy StepNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- stepReceiver, officeId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepNotification()
and
supportsVisibleFederation()
are true
StepOfficeSession getStepOfficeSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup step/office mappings.proxy
- a proxy StepOfficeSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsStepOffice()
is false
optional
- This method must be implemented if
supportsStepOffice()
is true.
StepOfficeAssignmentSession getStepOfficeAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning steps to
offices.proxy
- a proxy StepOfficeAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepOfficeAssignment()
is false
optional
- This method must be implemented if
supportsStepOfficeAssignment()
is true.
StepOfficeSession getStepSmartOfficeSession(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage step smart offices.officeId
- the Id
of the Office
proxy
- a proxy StepSmartOfficeSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepSmartOffice()
is false
optional
- This method must be implemented if
supportsStepSmartOffice()
is true.
WorkLookupSession getWorkLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the work lookup
service.proxy
- a proxy WorkLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkLookup()
is false
optional
- This method must be implemented if
supportsWorkLookup()
is true.
WorkLookupSession getWorkLookupSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the work lookup
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkLookupSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsWorkLookup()
and
supportsVisibleFederation()
are true
WorkQuerySession getWorkQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the work query
service.proxy
- a proxy WorkQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkQuery()
is false
optional
- This method must be implemented if
supportsWorkQuery()
is true.
WorkQuerySession getWorkQuerySessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the work query
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkQuerySession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsWorkQuery()
and
supportsVisibleFederation()
are true
WorkSearchSession getWorkSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the work search
service.proxy
- a proxy WorkSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkSearch()
is false
optional
- This method must be implemented if
supportsWorkSearch()
is true.
WorkSearchSession getWorkSearchSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the work search
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkSearchSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsWorkSearch()
and
supportsVisibleFederation()
are true
WorkAdminSession getWorkAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the work
administration service.proxy
- a proxy WorkAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkAdmin()
is false
optional
- This method must be implemented if
supportsWorkAdmin()
is true.
WorkAdminSession getWorkAdminSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the work
administration service for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkAdminSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsWorkAdmin()
and
supportsVisibleFederation()
are true
WorkNotificationSession getWorkNotificationSession(WorkReceiver workReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the work
notification service.workReceiver
- the notification callbackproxy
- a proxy WorkNotificationSession
NullArgumentException
- workReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkNotification()
is false
optional
- This method must be implemented if
supportsWorkNotification()
is true.
WorkNotificationSession getWorkNotificationSessionForOffice(WorkReceiver workReceiver, Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the work
notification service for the given office.workReceiver
- the notification callbackofficeId
- the Id
of the Office
proxy
- a proxy WorkNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- workReceiver, officeId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsWorkNotification()
and
supportsVisibleFederation()
are true
WorkOfficeSession getWorkOfficeSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup work/office mappings.proxy
- a proxy WorkOfficeSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkOffice()
is false
optional
- This method must be implemented if
supportsWorkOffice()
is true.
WorkOfficeAssignmentSession getWorkOfficeAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning work to
offices.proxy
- a proxy WorkOfficeAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkbOfficeAssignment()
is false
optional
- This method must be implemented if
supportsWorkOfficeAssignment()
is true.
WorkSmartOfficeSession getWorkSmartOfficeSession(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage work smart offices.officeId
- the Id
of the Office
proxy
- a proxy WorkSmartOfficeSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- no Office
found
by the given Id
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkSmartOffice()
is false
optional
- This method must be implemented if
supportsWorkSmartOffice()
is true.
WorkflowSession getWorkflowSession(Proxy proxy) throws OperationFailedException
OsidSession
for a workflow service.proxy
- a proxy WorkflowSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkflow()
is false
optional
- This method must be implemented if
supportsWorkflow()
is true.
WorkflowSession getWorkflowSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
for a workflow service for the
given office.officeId
- the Id
of the Office
proxy
- a proxy WorkflowSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkflow()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsWorkflow()
and
supportsVisibleFederation()
are true
WorkflowInitiationSession getWorkflowInitiationSession(Proxy proxy) throws OperationFailedException
OsidSession
for a workflow initiation service.proxy
- a proxy WorkflowInitiationSession
NullArgumentException
- proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowInitiation()
is false
optional
- This method must be implemented if
supportsWorkflowInitiation()
is true.
WorkflowInitiationSession getWorkflowInitiationSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
for a workflow initiation service
for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkflowInitiationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowInitiation()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsWorkflowInitiation()
and
supportsVisibleFederation()
are true
WorkflowManagementSession getWorkflowManagementSession(Proxy proxy) throws OperationFailedException
OsidSession
for a workflow management service.proxy
- a proxy WorkflowManagementSession
NullArgumentException
- proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowManagement()
is false
optional
- This method must be implemented if
supportsWorkflowManagement()
is true.
WorkflowManagementSession getWorkflowManagementSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
for a workflow management service
for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkflowManagementSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowManagement()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsWorkflowManagement()
and
supportsVisibleFederation()
are true
ManualWorkflowSession getManualWorkflowSession(Proxy proxy) throws OperationFailedException
OsidSession
for a manual workflow service.proxy
- a proxy ManualWorkflowSession
NullArgumentException
- proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsManualWorkflow()
is false
optional
- This method must be implemented if
supportsManualWorkflow()
is true.
ManualWorkflowSession getManualWorkflowSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
for a manual workflow service for
the given office.officeId
- the Id
of the Office
proxy
- a proxy ManualWorkflowSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsManualWorkflow()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsManualWorkflow()
and
supportsVisibleFederation()
are true
WorkflowEventLookupSession getWorkflowEventLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
for a workflow event lookup
service.proxy
- a proxy WorkflowEventLookupSession
NullArgumentException
- proxy is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowEventLookup()
is false
optional
- This method must be implemented if
supportsWorkflowEventLookup()
is true.
WorkflowEventLookupSession getWorkflowEventLookupSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
for a workflow event lookup
service for the given office.officeId
- the Id
of the Office
proxy
- a proxy WorkflowEventLookupSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- officeId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowEventLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsWorkflowEventLookup()
and
supportsVisibleFederation()
are true
WorkflowEventNotificationSession getWorkflowEventNotificationSession(WorkflowEventReceiver workflowEventReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the workflow event
notification service.workflowEventReceiver
- the notification callbackproxy
- a proxy WorkflowEventNotificationSession
NullArgumentException
- workflowEventReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowEventNotification()
is false
optional
- This method must be implemented if
supportsWorkflowEventNotification()
is true
WorkflowEventNotificationSession getWorkflowEventNotificationSessionForOffice(WorkflowEventReceiver workflowEventReceiver, Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the workflow event
notification service for the given office.workflowEventReceiver
- the notification callbackofficeId
- the Id
of the Office
proxy
- a proxy WorkflowEventNotificationSession
NotFoundException
- no office found by the given
Id
NullArgumentException
- workflowEventReceiver,
officeId,
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkflowEventNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsWorkflowEventNotification()
and
supportsVisibleFederation()
are true
OfficeLookupSession getOfficeLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the office lookup
service.proxy
- a proxy OfficeLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfficeLookup()
is false
optional
- This method must be implemented if
supportsOfficeLookup()
is true.
OfficeQuerySession getOfficeQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the office query
service.proxy
- a proxy OfficeQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfficeQuery()
is false
optional
- This method must be implemented if
supportsOfficeQuery()
is true.
OfficeSearchSession getOfficeSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the office search
service.proxy
- a proxy OfficeSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfficeSearch()
is false
optional
- This method must be implemented if
supportsOfficeSearch()
is true.
OfficeAdminSession getOfficeAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the office
administrative service.proxy
- a proxy OfficeAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfficeAdmin()
is false
optional
- This method must be implemented if
supportsOfficeAdmin()
is true.
OfficeNotificationSession getOfficeNotificationSession(OfficeReceiver officeReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the office
notification service.officeReceiver
- the notification callbackproxy
- a proxy OfficeNotificationSession
NullArgumentException
- officeReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfficeNotification()
is false
optional
- This method must be implemented if
supportsOfficeNotification()
is true.
OfficeHierarchySession getOfficeHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the office
hierarchy service.proxy
- a proxy OfficeHierarchySession
for officesNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfficeHierarchy()
is false
optional
- This method must be implemented if
supportsOfficeHierarchy()
is true.
OfficeHierarchyDesignSession getOfficeHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the office
hierarchy design service.proxy
- a proxy HierarchyDesignSession
for officesNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfficeHierarchyDesign()
is false
optional
- This method must be implemented if
supportsOfficeHierarchyDesign()
is true.
WorkflowBatchProxyManager getWorkflowBatchProxyManager() throws OperationFailedException
WorkflowBatchProxyManager.
WorkflowbatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkflowBatch()
is false
optional
- This method must be implemented if
supportsWorkflowBatch()
is true.
WorkflowRulesProxyManager getWorkflowRulesProxyManager() throws OperationFailedException
WorkflowRulesProxyManager
. WorkflowRulesProxyManager
for officesOperationFailedException
- unable to complete requestUnimplementedException
- supportsWorkflowRules()
is false
optional
- This method must be implemented if
supportsWorkflowRules()
is true.