Class UsermessagingManager

Description
Description | Methods (details)

<p> The Manager sends and receives messages and returns the Types of messages and delivery supported by the implementation. A message is not created explicitly; it is created when it is sent.

</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/usermessaging/UsermessagingManager.php (line 41) 

OsidManager
   |
   --UsermessagingManager
Method Summary
Description | Methods (details)
void deleteMessage (mixed $message, object Message $message )
void deleteMessages (int $before, object Type $messageType, mixed $topic, string $topic )
object TypeIterator getDeliveryTypes ()
object TypeIterator getMessageTypes ()
object IdIterator getSubscribers ()
object IdIterator getSubscribersByTopic (mixed $topic, string $topic )
object StringIterator getTopics ()
void purgeMessage (mixed $message, object Message $message )
object MessageIterator receive ()
object MessageIterator receiveForMessageType (mixed $messageType, object Type $messageType )
object MessageIterator receiveForTopic (mixed $topic, string $topic )
void send (object Id[] $agents, object mixed $content, object Type $messageType, object Type $deliveryType, mixed $topic, string $topic )
void sendToAll (object mixed $content, object Type $messageType, object Type $deliveryType, mixed $topic, string $topic )
void subscribe (object Id $agentId, mixed $topic, string $topic )
void unsubscribe (object Id $agentId, mixed $topic, string $topic )
void unsubscribeAll (mixed $agentId, object Id $agentId )
Methods
Description | Methods (details)
deleteMessage (line 423)

Delete a Message for the user.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void deleteMessage (mixed $message, object Message $message )
deleteMessages (line 478)

Delete all Messages for the user. Include only Messages before a date, on a Topic, and of a specific MessageType if those values are supplied.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void deleteMessages (int $before, object Type $messageType, mixed $topic, string $topic )
getDeliveryTypes (line 66)

Get all the Types of Messages supported by this implementation.

Examples of these Types are instant, store and forward, and attempt to deliver once.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object TypeIterator getDeliveryTypes ()
getMessageTypes (line 91)

Get all the Types of Messages supported by this implementation.

Examples of these are rich-text and MIME.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object TypeIterator getMessageTypes ()
getSubscribers (line 142)

Get all the current subscribers to this Service.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object IdIterator getSubscribers ()
getSubscribersByTopic (line 168)

Get all the current subscribers to this Service for a specific Topic.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object IdIterator getSubscribersByTopic (mixed $topic, string $topic )
  • string $topic
getTopics (line 118)

Get all the Topics supported by this implementation. This might also be all the currently available Topics in the case of an implementation that allows applications to add Topics by sending a Message with a new Topic.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object StringIterator getTopics ()
purgeMessage (line 449)

Delete a Message for all subscribers.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
void purgeMessage (mixed $message, object Message $message )
receive (line 397)

Get all Messages.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object MessageIterator receive ()
receiveForMessageType (line 373)

Get all Messages of a specific Message Type.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object MessageIterator receiveForMessageType (mixed $messageType, object Type $messageType )
receiveForTopic (line 347)

Get all Messages for a specific Topic.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
object MessageIterator receiveForTopic (mixed $topic, string $topic )
  • string $topic
send (line 285)

Send a Message to a recipient. The Topic is optional and should be ignored if null.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE, UNKNOWN_TOPIC, UNKNOWN_ID
void send (object Id[] $agents, object mixed $content, object Type $messageType, object Type $deliveryType, mixed $topic, string $topic )
  • object Id[] $agents
  • object mixed $content: (original type: java.io.Serializable)
  • object Type $messageType
  • object Type $deliveryType
  • string $topic
sendToAll (line 321)

Send a Message to all subscribers. The Topic is optional and should be ignored if null.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_TYPE, UNKNOWN_TOPIC, UNKNOWN_ID
void sendToAll (object mixed $content, object Type $messageType, object Type $deliveryType, mixed $topic, string $topic )
  • object mixed $content: (original type: java.io.Serializable)
  • object Type $messageType
  • object Type $deliveryType
  • string $topic
subscribe (line 195)

Subscribe an agentId for a particular topic.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, UNKNOWN_TOPIC
void subscribe (object Id $agentId, mixed $topic, string $topic )
unsubscribe (line 222)

Unsubscribe an agentId for a particular topic.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, UNKNOWN_TOPIC
void unsubscribe (object Id $agentId, mixed $topic, string $topic )
unsubscribeAll (line 248)

Unsubscribe an agentId for all topics.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NOT_SUBSCRIBED
void unsubscribeAll (mixed $agentId, object Id $agentId )

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

Documentation generated on Wed, 19 Sep 2007 10:27:39 -0400 by phpDocumentor 1.3.0RC3