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

This session provides methods to apply ContactEnablers to Contacts. A Contact with multiple ContactEnablers means any positive rule evaluation across the enablers result in an effective Contact.

MethodgetAddressBookId
Description

Gets the AddressBook Id associated with this session.

Returnosid.id.Idthe AddressBook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAddressBook
Description

Gets the AddressBook associated with this session.

Returnosid.contact.AddressBookthe address book
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignContactEnablers
Description

Tests if this user can alter contact enabler/contact 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.
MethodassignContactEnablerToContact
Description

Adds an existing ContactEnabler to a Contact.

Parametersosid.id.IdcontactEnablerIdthe Id of the ContactEnabler
osid.id.IdcontactIdthe Id of the Contact
ErrorsALREADY_EXISTS contactEnablerId is already applied to contactId
NOT_FOUND contactEnablerId or contactId not found
NULL_ARGUMENT contactEnablerId or contactId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignContactEnablerFromContact
Description

Removes a ContactEnabler from a Contact.

Parametersosid.id.IdcontactEnablerIdthe Id of the ContactEnabler
osid.id.IdcontactIdthe Id of the Contact
ErrorsNOT_FOUND contactEnablerId or contactId not found or contactEnablerId is not applied to contactId
NULL_ARGUMENT contactEnablerId or contactId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceContactEnablers
Description

Tests if this user can order ContactEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if ContactEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveContactEnablerAhead
Description

Reorders contact enablers for a contact by moving the specified contact enabler in front of a reference contact enabler.

Parametersosid.id.IdcontactEnablerIdthe Id of a ContactEnabler
osid.id.IdcontactIdthe Id of a Contact
osid.id.IdreferenceIdthe reference contact enabler Id
ErrorsNOT_FOUND contactEnabelrId, contactId, or referenceId not found or, contactEnablerId or referenceId not related to contactId
NULL_ARGUMENT contactEnablerId, contactId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveContactEnablerBehind
Description

Reorders contact enablers for a contact by moving the specified contact enabler behind a reference contact enabler.

Parametersosid.id.IdcontactEnablerIdthe Id of a ContactEnabler
osid.id.IdcontactIdthe Id of a Contact
osid.id.IdreferenceIdthe reference contact enabler Id
ErrorsNOT_FOUND contactEnabelrId, contactId, or referenceId not found or, contactEnablerId or referenceId not related to contactId
NULL_ARGUMENT contactEnablerId, contactId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderContactEnablers
Description

Reorders a set of contact enablers for a contact.

Parametersosid.id.Id[]contactEnablerIdthe Ids for a set of ContactEnablers
osid.id.IdcontactIdthe Id of a Contact
ErrorsNOT_FOUND contactId not found or, a contactEnablerId not related to contactId
NULL_ARGUMENT contactEnablerIds or contactId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.