OSID - osid.resource.demographic.DemographicEnablerAdminSession Service Interface Definition

Interface	osid.resource.demographic.DemographicEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session creates and removes demographic enablers. The data for create and update is provided via the `DemographicEnablerForm`.
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the bin
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDemographicEnabler
Description	Tests if this user can create demographic enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `DemographicEnabler` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `DemographicEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDemographicEnablerWithRecordTypes
Description	Tests if this user can create a single `DemographicEnabler` using the desired record types. While `ResourceDemographicManager.getDemographicEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `DemographicEnabler`. Providing an empty array tests if a `DemographicEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`demographicEnablerRecordTypes`	array of demographic enabler record types
Return	`boolean`		`true` if `DemographicEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`demographicEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablerFormForCreate
Description	Gets the demographic enabler form for creating new demographic enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`demographicEnablerRecordTypes`	array of demographic enabler record types
Return	`osid.resource.demographic.DemographicEnablerForm`		the demographic enabler form
Errors	NULL_ARGUMENT		`demographicEnablerRecordTypes` 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	createDemographicEnabler
Description	Creates a new `DemographicEnabler`.
Parameters	`osid.resource.demographic.DemographicEnablerForm`	`demographicEnablerForm`	the form for this `DemographicEnabler`
Return	`osid.resource.demographic.DemographicEnabler`		the new `DemographicEnabler`
Errors	ALREADY_EXISTS		attempt at duplicating a property the underlying system is enforcing to be unique
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`demographicEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicEnablerForm` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDemographicEnablers
Description	Tests if this user can update demographic enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `DemographicEnabler` 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 `DemographicEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDemographicEnabler
Description	Tests if this user can update a demographic enabler. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `DemographicEnabler` 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.
Parameters	`osid.id.Id`	`demographicEnablerId`	the `Id` of the `DemographicEnabler`
Return	`boolean`		`false` if demographic enabler modification is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`demographicEnablerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `demographicEnablerId` is not found, then it is acceptable to return false to indicate the lack of an update available.
Method	getDemographicEnablerFormForUpdate
Description	Gets the demographic enabler form for updating an existing demographic enabler. A new demographic enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`demographicEnablerId`	the `Id` of the `DemographicEnabler`
Return	`osid.resource.demographic.DemographicEnablerForm`		the demographic enabler form
Errors	NOT_FOUND		`demographicEnablerId` is not found
	NULL_ARGUMENT		`demographicEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDemographicEnabler
Description	Updates an existing demographic enabler.
Parameters	`osid.resource.demographic.DemographicEnablerForm`	`demographicEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`demographicEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`demographicEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicEnablerForm` did not originate from `getDemographicEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDemographicEnablers
Description	Tests if this user can delete demographic enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `DemographicEnabler` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `DemographicEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDemographicEnabler
Description	Tests if this user can delete a specified `DemographicEnabler`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `DemographicEnabler` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user.
Parameters	`osid.id.Id`	`demographicEnablerId`	the `Id` of the `DemographicEnabler`
Return	`boolean`		`false` if deletion of this `DemographicEnabler` is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`demographicEnablerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `demographicEnablerId` is not found, then it is acceptable to return false to indicate the lack of a delete available.
Method	deleteDemographicEnabler
Description	Deletes a `DemographicEnabler`.
Parameters	`osid.id.Id`	`demographicEnablerId`	the `Id` of the `DemographicEnabler` to remove
Errors	NOT_FOUND		`demographicEnablerId` not found
	NULL_ARGUMENT		`demographicEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDemographicEnablerAliases
Description	Tests if this user can manage `Id` aliases for demographic enablers. 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 `DemographicEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDemographicEnabler
Description	Adds an `Id` to a `DemographicEnabler` for the purpose of creating compatibility. The primary `Id` of the `DemographicEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another demographic enabler. it is reassigned to the given demographic enabler `Id`.
Parameters	`osid.id.Id`	`demographicEnablerId`	the `Id` of a `DemographicEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`demographicEnablerId` not found
	NULL_ARGUMENT		`demographicEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.