Interface | osid.contact.rules.ContactEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes contact enablers. The data
for create and update is provided via the | ||
Method | getAddressBookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the AddressBook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressBook | ||
Description |
Gets the | ||
Return | osid.contact.AddressBook | the address book | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateContactEnabler | ||
Description |
Tests if this user can create contact enablers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known creating a | ||
Return | boolean | false if ContactEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateContactEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | contactEnablerRecordTypes | array of contact enabler record types |
Return | boolean | true if ContactEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | contactEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerFormForCreate | ||
Description |
Gets the contact enabler form for creating new contact enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | contactEnablerRecordTypes | array of contact enabler record types |
Return | osid.contact.rules.ContactEnablerForm | the contact enabler form | |
Errors | NULL_ARGUMENT | contactEnablerRecordTypes 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 | createContactEnabler | ||
Description |
Creates a new | ||
Parameters | osid.contact.rules.ContactEnablerForm | contactEnablerForm | the form for this ContactEnabler |
Return | osid.contact.rules.ContactEnabler | the new ContactEnabler | |
Errors | ILLEGAL_STATE | contactEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | contactEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | contactEnablerForm did not originate from
getContactEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateContactEnablers | ||
Description |
Tests if this user can update contact enablers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known updating a | ||
Return | boolean | false if ContactEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactEnablerFormForUpdate | ||
Description |
Gets the contact enabler form for updating an existing contact enabler. A new contact enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | contactEnablerId | the Id of the ContactEnabler |
Return | osid.contact.rules.ContactEnablerForm | the contact enabler form | |
Errors | NOT_FOUND | contactEnablerId is not found | |
NULL_ARGUMENT | contactEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateContactEnabler | ||
Description |
Updates an existing contact enabler. | ||
Parameters | osid.contact.rules.ContactEnablerForm | contactEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | contactEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | contactEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | contactEnablerForm did not originate from
getContactEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteContactEnablers | ||
Description |
Tests if this user can delete contact enablers. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known deleting a | ||
Return | boolean | false if ContactEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteContactEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | contactEnablerId | the Id of the ContactEnabler to remove |
Errors | NOT_FOUND | contactEnablerId not found | |
NULL_ARGUMENT | contactEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageContactEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ContactEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasContactEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | contactEnablerId | the Id of a ContactEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | contactEnablerId not found | ||
NULL_ARGUMENT | contactEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |