OSID - osid.offering.ParticipantAdminSession Service Interface Definition

Interface	osid.offering.ParticipantAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.offering.batch.ParticipantBatchAdminSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session creates, updates, and deletes `Partiicpants` . The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Participant` , a `ParticipantForm` is requested using `getParticipantFormForCreate()` specifying the offering, resource, and desired record `Types` or none if no record `Types` are needed. The returned `ParticipantForm` 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 `ParticipantForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ParticipantForm` corresponds to an attempted transaction. For updates, `ParticipantForms` are requested to the `Participant` `Id` that is to be updated using `getParticipantFormForUpdate()` . Similarly, the `ParticipantForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ParticipantForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Participants` . To unmap a `Participant` from the current `Catalogue` , the `ParticipantCatalogueAssignmentSession` should be used. These delete operations attempt to remove the `Participant` itself thus removing it from all known `Catalogue` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateParticipants
Description	Tests if this user can create participants. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Participant` will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Participant` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateParticipantWithRecordTypes
Description	Tests if this user can create a single `Participant` using the desired record types. While `OfferingManager.getParticipantRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Participant` . Providing an empty array tests if a `Participant` can be created with no records.
Parameters	`osid.type.Type[]`	`participantRecordTypes`	array of participant record types
Return	`boolean`		`true` if `Participant` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`participantRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantFormForCreate
Description	Gets the participant form for creating new participants. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`offeringId`	the offering `Id` to which this participant belongs
	`osid.id.Id`	`resourceId`	the resource `Id` for this participant
	`osid.type.Type[]`	`participantRecordTypes`	array of participant record types to be included in the create operation or an empty list if none
Return	`osid.offering.ParticipantForm`		the participant form
Errors	NOT_FOUND		`offeringId` or `resourceId` is not found
	NULL_ARGUMENT		`offeringId, resourceId` , or `participantRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createParticipant
Description	Creates a new `Participant` .
Parameters	`osid.offering.ParticipantForm`	`participantForm`	the form for this `Participant`
Return	`osid.offering.Participant`		the new `Participant`
Errors	ILLEGAL_STATE		`participantForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`participantForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`participantForm` did not originate from `getParticipantFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateParticipants
Description	Tests if this user can update participants. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Participant` will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Participant` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantFormForUpdate
Description	Gets the participant form for updating an existing participant. A new participant form should be requested for each update transaction.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the `Participant`
Return	`osid.offering.ParticipantForm`		the participant form
Errors	NOT_FOUND		`participantId` is not found
	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateParticipant
Description	Updates an existing participant.
Parameters	`osid.offering.ParticipantForm`	`participantForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`participantForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`participantForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`participantForm` did not originate from `getParticipantFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteParticipants
Description	Tests if this user can delete participants. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Participant` will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Participant` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteParticipant
Description	Deletes a `Participant` .
Parameters	`osid.id.Id`	`participantId`	the `Id` of the `Participant` to remove
Errors	NOT_FOUND		`participantId` not found
	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageParticipantAliases
Description	Tests if this user can manage `Id` aliases for `Participants` . 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 `Participant` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasParticipant
Description	Adds an `Id` to a `Participant` for the purpose of creating compatibility. The primary `Id` of the `Participant` is determined by the provider. The new `Id` is an alias to the primary `Id` . If the alias is a pointer to another participant, it is reassigned to the given participant `Id` .
Parameters	`osid.id.Id`	`participantId`	the `Id` of a `Participant`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`participantId` not found
	NULL_ARGUMENT		`participantId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.