OSID - osid.workflow.rules.ProcessEnablerOfficeSession Service Interface Definition

Interface	osid.workflow.rules.ProcessEnablerOfficeSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `ProcessEnabler` to `Office` mappings. A `ProcessEnabler` may appear in multiple `Office` objects. Each office may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupProcessEnablerOfficeMappings
Description	Tests if this user can perform lookups of process enabler/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProcessEnablerOfficeView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryProcessEnablerOfficeView
Description	A complete view of the `ProcessEnabler` and `Office` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getProcessEnablerIdsByOffice
Description	Gets the list of `ProcessEnablerIds` associated with an `Office.`
Parameters	`osid.id.Id`	`officeId`	`Id` of the `Office`
Return	`osid.id.IdList`		list of related process enabler `Ids`
Errors	NOT_FOUND		`officeId` is not found
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablersByOffice
Description	Gets the list of process enabler associated with an `Office.`
Parameters	`osid.id.Id`	`officeId`	`Id` of the `Office`
Return	`osid.workflow.rules.ProcessEnablerList`		list of related process enablers
Errors	NOT_FOUND		`officeId` is not found
	NULL_ARGUMENT		`officeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablerIdsByOffices
Description	Gets the list of `ProcessEnabler Ids` corresponding to a list of `Offices.`
Parameters	`osid.id.IdList`	`officeIds`	list of office `Ids`
Return	`osid.id.IdList`		list of process enabler `Ids`
Errors	NULL_ARGUMENT		`officeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessEnablersByOffices
Description	Gets the list of process enabler corresponding to a list of `Offices.`
Parameters	`osid.id.IdList`	`officeIds`	list of office `Ids`
Return	`osid.workflow.rules.ProcessEnablerList`		list of process enablers
Errors	NULL_ARGUMENT		`officeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeIdsByProcessEnabler
Description	Gets the `Office` `Ids` mapped to a `ProcessEnabler.`
Parameters	`osid.id.Id`	`processEnablerId`	`Id` of a `ProcessEnabler`
Return	`osid.id.IdList`		list of offices
Errors	NOT_FOUND		`processEnablerId` is not found
	NULL_ARGUMENT		`processEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfficesByProcessEnabler
Description	Gets the `Offices` mapped to a `ProcessEnabler.`
Parameters	`osid.id.Id`	`processEnablerId`	`Id` of a `ProcessEnabler`
Return	`osid.workflow.OfficeList`		list of offices
Errors	NOT_FOUND		`processEnablerId` is not found
	NULL_ARGUMENT		`processEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.