OSID Logo
OSID Specifications
contact rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.rules.ContactEnablerAddressBookAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign ContactEnabler to AddressBook mappings. A ContactEnabler may appear in multiple AddressBook objects and removing the last reference to a ContactEnabler is the equivalent of deleting it. Each AddressBook may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a ContactEnabler to another AddressBook is not a copy operation (eg: does not change its Id ).

MethodcanAssignContactEnablers
Description

Tests if this user can alter contact enabler/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignContactEnablersToAddressBook
Description

Tests if this user can alter contact enabler/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT addressBookId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableAddressBookIds
Description

Gets a list of address books including and under the given address book node in which any contact enabler can be assigned.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
Returnosid.id.IdListlist of assignable address book Ids
ErrorsNULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableAddressBookIdsForContactEnabler
Description

Gets a list of address books including and under the given address book node in which a specific contact enabler can be assigned.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.id.IdcontactEnablerIdthe Id of the ContactEnabler
Returnosid.id.IdListlist of assignable address book Ids
ErrorsNULL_ARGUMENT addressBookId or contactEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignContactEnablerToAddressBook
Description

Adds an existing ContactEnabler to an AddressBook.

Parametersosid.id.IdcontactEnablerIdthe Id of the ContactEnabler
osid.id.IdaddressBookIdthe Id of the AddressBook
ErrorsALREADY_EXISTS contactEnablerId is already assigned to addressBookId
NOT_FOUND contactEnablerId or addressBookId not found
NULL_ARGUMENT contactEnablerId or addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignContactEnablerFromAddressBook
Description

Removes a ContactEnabler from an AddressBook.

Parametersosid.id.IdcontactEnablerIdthe Id of the ContactEnabler
osid.id.IdaddressBookIdthe Id of the AddressBook
ErrorsNOT_FOUND contactEnablerId or addressBookId not found or contactEnablerId is not assigned to addressBookId
NULL_ARGUMENT contactEnablerId or addressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignContactEnablerToAddressBook
Description

Moves a ContactEnabler from one AddressBook to another. Mappings to other AddressBooks are unaffected.

Parametersosid.id.IdcontactEnablerIdthe Id of the ContactEnabler
osid.id.IdfromAddressBookIdthe Id of the current AddressBook
osid.id.IdtoAddressBookIdthe Id of the destination AddressBook
ErrorsNOT_FOUND contactEnablerId, fromAddressBookId, or toAddressBookId not found or contactEnablerId not mapped to fromAddressBookId
NULL_ARGUMENT contactEnablerId, fromAddressBookId, or toAddressBookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.