Interface | osid.contact.ContactAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateContacts | ||
Description |
Tests if this user can create contacts. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known creating a | ||
Return | boolean | false if Contact creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateContactWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | contactRecordTypes | array of contact record types |
Return | boolean | true if Contact creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | contactRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactFormForCreate | ||
Description |
Gets the contact form for creating new contacts. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | addressId | the Id for the address |
osid.id.Id | referenceId | the Id for the reference | |
osid.type.Type[] | contactRecordTypes | array of contact record types | |
Return | osid.contact.ContactForm | the contact form | |
Errors | NOT_FOUND | addressId is not found | |
NULL_ARGUMENT | addressId, referenceId, or contactRecordTypes
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 | createContact | ||
Description |
Creates a new | ||
Parameters | osid.contact.ContactForm | contactForm | the form for this Contact |
Return | osid.contact.Contact | the new Contact | |
Errors | ILLEGAL_STATE | contactForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | contactForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | contactForm did not originate from
getContactFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateContacts | ||
Description |
Tests if this user can update contacts. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known updating a | ||
Return | boolean | false if Contact modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getContactFormForUpdate | ||
Description |
Gets the contact form for updating an existing contact. A new contact form should be requested for each update transaction. | ||
Parameters | osid.id.Id | contactId | the Id of the Contact |
Return | osid.contact.ContactForm | the contact form | |
Errors | NOT_FOUND | contactId is not found | |
NULL_ARGUMENT | contactId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateContact | ||
Description |
Updates an existing contact. | ||
Parameters | osid.contact.ContactForm | contactForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | contactForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | contactForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | contactForm did not originate from
getContactFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteContacts | ||
Description |
Tests if this user can delete contacts. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting an | ||
Return | boolean | false if Contact deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteContact | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | contactId | the Id of the Contact to remove |
Errors | NOT_FOUND | contactId not found | |
NULL_ARGUMENT | contactId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageContactAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Contact aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasContact | ||
Description |
Adds an | ||
Parameters | osid.id.Id | contactId | the Id of a Contact |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | contactId not found | ||
NULL_ARGUMENT | contactId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |