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

Interface	osid.resource.demographic.DemographicAdminSession
Implements	`osid.OsidSession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session creates and removes demographics. The data for create and update is provided via the `DemographicForm`.
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	canCreateDemographic
Description	Tests if this user can create demographics. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Demographic` 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 `Demographic` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateDemographicWithRecordTypes
Description	Tests if this user can create a single `Demographic` using the desired record types. While `ResourceDemographicManager.getDemographicRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Demographic`. Providing an empty array tests if a `Demographic` can be created with no records.
Parameters	`osid.type.Type[]`	`demographicRecordTypes`	array of demographic record types
Return	`boolean`		`true` if `Demographic` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`demographicRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicFormForCreate
Description	Gets the demographic form for creating new demographics. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`demographicRecordTypes`	array of demographic record types
Return	`osid.resource.demographic.DemographicForm`		the demographic form
Errors	NULL_ARGUMENT		`demographicRecordTypes` 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	createDemographic
Description	Creates a new `Demographic`.
Parameters	`osid.resource.demographic.DemographicForm`	`demographicForm`	the form for this `Demographic`
Return	`osid.resource.demographic.Demographic`		the new `Demographic`
Errors	ILLEGAL_STATE		`demographicForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`demographicForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicForm` did not originate from `getDemographicFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateDemographics
Description	Tests if this user can update demographics. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Demographic` 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 `Demographic` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicFormForUpdate
Description	Gets the demographic form for updating an existing demographic. A new demographic form should be requested for each update transaction.
Parameters	`osid.id.Id`	`demographicId`	the `Id` of the `Demographic`
Return	`osid.resource.demographic.DemographicForm`		the demographic form
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateDemographic
Description	Updates an existing demographic.
Parameters	`osid.resource.demographic.DemographicForm`	`demographicForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`demographicForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`demographicId` or `demographicForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`demographicForm` did not originate from `getDemographicFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteDemographics
Description	Tests if this user can delete demographics. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Demographic` 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 `Demographic` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteDemographic
Description	Deletes a `Demographic`.
Parameters	`osid.id.Id`	`demographicId`	the `Id` of the `Demographic` to remove
Errors	NOT_FOUND		`demographicId` not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageDemographicAliases
Description	Tests if this user can manage `Id` aliases for demographics. 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 `Demographic` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasDemographic
Description	Adds an `Id` to a `Demographic` for the purpose of creating compatibility. The primary `Id` of the `Demographic` 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. it is reassigned to the given demographic `Id`.
Parameters	`osid.id.Id`	`demographicId`	the `Id` of a `Demographic`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`demographicId` not found
	NULL_ARGUMENT		`demographicId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.