OSID - osid.workflow.event.WorkflowEventAdminSession Service Interface Definition

Interface	osid.workflow.event.WorkflowEventAdminSession
Implements	`osid.OsidSession`
Used By	`osid.workflow.event.WorkflowEventManager`
Used By	`osid.workflow.event.WorkflowEventProxyManager`
Description	This session creates, updates, and deletes `WorkflowEvents` . The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `WorkflowEvent` , a `WorkflowEventForm` is requested using `getWorkflowEventFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `WorkflowEventForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `WorkflowEventForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `WorkflowEventForm` corresponds to an attempted transaction. For updates, `WorkflowEventForms` are requested to the `WorkflowEvent` `Id` that is to be updated using `getWorkflowEventFormForUpdate()` . Similarly, the `WorkflowEventForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `WorkflowEventForm` can only be used once for a successful update and cannot be reused. The delete operations delete `WorkflowEvents` . To unmap a `WorkflowEvent` from the current `Office` , the `WorkflowEventOfficeAssignmentSession` should be used. These delete operations attempt to remove the `WorkflowEvent` itself thus removing it from all known `Office` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned `Id` .
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateWorkflowEvents
Description	Tests if this user can create `WorkflowEvents` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `WorkflowEvent` will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `WorkflowEvent` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateWorkflowEventWithRecordTypes
Description	Tests if this user can create a single `WorkflowEvent` using the desired record types. While `WorkflowEventManager.getWorkflowEventRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `WorkflowEvent` . Providing an empty array tests if a `WorkflowEvent c` an be created with no records.
Parameters	`osid.type.Type[]`	`workflowEventRecordTypes`	array of workflow event record types
Return	`boolean`		`true` if `WorkflowEvent` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`workflowEventRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventFormForCreate
Description	Gets the workflow event form for creating new workflow events. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`workflowEventRecordTypes`	array of workflow event record types
Return	`osid.workflow.event.WorkflowEventForm`		the workflow event form
Errors	NULL_ARGUMENT		`workflowEventRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createWorkflowEvent
Description	Creates a new `WorkflowEvent` .
Parameters	`osid.workflow.event.WorkflowEventForm`	`workflowEventForm`	the form for this `WorkflowEvent`
Return	`osid.workflow.event.WorkflowEvent`		the new `WorkflowEvent`
Errors	ILLEGAL_STATE		`workflowEventForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`workflowEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workflowEventForm` did not originate from `getWorkflowEventFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateWorkflowEvents
Description	Tests if this user can update WorkflowEvents. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a WorkflowEvent will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `WorkflowEvent` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventFormForUpdate
Description	Gets the workflow event form for updating an existing workflow event. A new workflow event form should be requested for each update transaction.
Parameters	`osid.id.Id`	`workflowEventId`	the `Id` of the `WorkflowEvent`
Return	`osid.workflow.event.WorkflowEventForm`		the workflow event form
Errors	NOT_FOUND		`workflowEventId` is not found
	NULL_ARGUMENT		`workflowEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateWorkflowEvent
Description	Updates an existing workflow event.
Parameters	`osid.workflow.event.WorkflowEventForm`	`workflowEventForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`workflowEventForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`workflowEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`workflowEventForm` did not originate from `getWorkflowEventFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteWorkflowEvents
Description	Tests if this user can delete `WorkflowEvents` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `WorkflowEvent` will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `WorkflowEvent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteWorkflowEvent
Description	Deletes a `WorkflowEvent` .
Parameters	`osid.id.Id`	`workflowEventId`	the `Id` of the `WorkflowEvent` to remove
Errors	NOT_FOUND		`workflowEventId` not found
	NULL_ARGUMENT		`workflowEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageWorkflowEventAliases
Description	Tests if this user can manage `Id` aliases for `WorkflowEvents` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED` .This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `WorkflowEvent` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasWorkflowEvent
Description	Adds an `Id` to a `WorkflowEvent` for the purpose of creating compatibility. The primary `Id` of the `WorkflowEvent` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another workflow event, it is reassigned to the given workflow event Id.
Parameters	`osid.id.Id`	`workflowEventId`	the `Id` of a `WorkflowEvent`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`workflowEventId` not found
	NULL_ARGUMENT		`workflowEventId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.