| java.lang.Object
 org.sakaiproject.message.impl.BaseMessageService
org.sakaiproject.chat.impl.BaseChatService
All known Subclasses: org.sakaiproject.chat.impl.DbChatService,
| Inner Class :public class BaseChatChannelEdit extends BaseMessageChannelEdit implements ChatChannelEdit | |
| Inner Class :public class BaseChatMessageEdit extends BaseMessageEdit implements ChatMessageEdit | |
| Inner Class :public class BaseChatMessageHeaderEdit extends BaseMessageHeaderEdit implements ChatMessageHeaderEdit | |
| Field Summary | |
| final public static String | ATTR_TOP_REFRESH
Tool session attribute name used to schedule a whole page refresh. |
| Method Summary | |
| public ChatChannelEdit | addChatChannel(String ref)
Add a new chat channel.
Parameters:
ref - The channel reference. | | public String | archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
| | public void | contextCreated(String context, boolean toolPlacement)
| | public void | contextDeleted(String context, boolean toolPlacement)
| | public void | contextUpdated(String context, boolean toolPlacement)
| | protected String | eventId(String secure)
Form a tracking event string based on a security function string.
Parameters:
secure - The security function string. | | public ChatChannel | getChatChannel(String ref)
Return a specific chat channel.
Parameters:
ref - The channel reference. | | public Time | getDate(Entity r)
Access the resource date.
Parameters:
r - The resource. | | public String | getLabel()
| | public String | getOwnerId(Entity r)
Access the resource owner user id.
Parameters:
r - The resource. | | protected String | getReferenceRoot()
Return the reference rooot for use in resource references and urls. | | public void | init()
Final initialization, once all dependencies are set. | | public boolean | isDraft(Entity r)
Check if this resource is in draft mode.
Parameters:
r - The resource. | | public String | merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)
| | public String[] | myToolIds()
| | public Entity | newContainer(String ref)
Construct a new continer given just ids.
Parameters:
ref - The channel reference. | | public Entity | newContainer(Element element)
Construct a new container resource, from an XML element.
Parameters:
element - The XML. | | public Entity | newContainer(Entity other)
Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. | | public Edit | newContainerEdit(String ref)
Construct a new continer given just ids.
Parameters:
ref - The channel reference. | | public Edit | newContainerEdit(Element element)
Construct a new container resource, from an XML element.
Parameters:
element - The XML. | | public Edit | newContainerEdit(Entity other)
Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. | | protected MessageHeaderEdit | newMessageHeader(Message msg, String id)
Construct a new message header from XML in a DOM element.
Parameters:
id - The message Id. | | protected MessageHeaderEdit | newMessageHeader(Message msg, Element el)
Construct a new message header from XML in a DOM element.
Parameters:
el - The XML DOM element that has the header information. | | protected MessageHeaderEdit | newMessageHeader(Message msg, MessageHeader other)
Construct a new message header as a copy of another.
Parameters:
other - The other header to copy. | | public Entity | newResource(Entity container, String id, Object[] others)
Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. | | public Entity | newResource(Entity container, Element element)
Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. | | public Entity | newResource(Entity container, Entity other)
Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. | | public Edit | newResourceEdit(Entity container, String id, Object[] others)
Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. | | public Edit | newResourceEdit(Entity container, Element element)
Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. | | public Edit | newResourceEdit(Entity container, Entity other)
Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. | | public boolean | parseEntityReference(String reference, Reference ref)
| | protected String | serviceName()
Report the Service API name being implemented. | | public Object[] | storageFields(Entity r)
Collect the fields that need to be stored outside the XML (for the resource). | | public void | transferCopyEntities(String fromContext, String toContext, List ids)
| | public boolean | willArchiveMerge()
|
| ATTR_TOP_REFRESH | | final public static String ATTR_TOP_REFRESH(Code) | | Tool session attribute name used to schedule a whole page refresh.
|
| contextCreated | | public void contextCreated(String context, boolean toolPlacement)(Code) | | |
| contextDeleted | | public void contextDeleted(String context, boolean toolPlacement)(Code) | | |
| contextUpdated | | public void contextUpdated(String context, boolean toolPlacement)(Code) | | |
| eventId | | protected String eventId(String secure)(Code) | | Form a tracking event string based on a security function string.
Parameters:
secure - The security function string. The event tracking string. |
| getDate | | public Time getDate(Entity r)(Code) | | Access the resource date.
Parameters:
r - The resource. The resource date. |
| getOwnerId | | public String getOwnerId(Entity r)(Code) | | Access the resource owner user id.
Parameters:
r - The resource. The resource owner user id. |
| getReferenceRoot | | protected String getReferenceRoot()(Code) | | Return the reference rooot for use in resource references and urls.
The reference rooot for use in resource references and urls. |
| init | | public void init()(Code) | | Final initialization, once all dependencies are set.
|
| isDraft | | public boolean isDraft(Entity r)(Code) | | Check if this resource is in draft mode.
Parameters:
r - The resource. true if the resource is in draft mode, false if not. |
| newContainer | | public Entity newContainer(String ref)(Code) | | Construct a new continer given just ids.
Parameters:
ref - The channel reference. The new containe Resource. |
| newContainer | | public Entity newContainer(Element element)(Code) | | Construct a new container resource, from an XML element.
Parameters:
element - The XML. The new container resource. |
| newContainer | | public Entity newContainer(Entity other)(Code) | | Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. The new container resource. |
| newContainerEdit | | public Edit newContainerEdit(String ref)(Code) | | Construct a new continer given just ids.
Parameters:
ref - The channel reference. The new containe Resource. |
| newContainerEdit | | public Edit newContainerEdit(Element element)(Code) | | Construct a new container resource, from an XML element.
Parameters:
element - The XML. The new container resource. |
| newContainerEdit | | public Edit newContainerEdit(Entity other)(Code) | | Construct a new container resource, as a copy of another
Parameters:
other - The other contianer to copy. The new container resource. |
| newMessageHeader | | protected MessageHeaderEdit newMessageHeader(Message msg, String id)(Code) | | Construct a new message header from XML in a DOM element.
Parameters:
id - The message Id. The new message header. |
| newMessageHeader | | protected MessageHeaderEdit newMessageHeader(Message msg, Element el)(Code) | | Construct a new message header from XML in a DOM element.
Parameters:
el - The XML DOM element that has the header information. The new message header. |
| newMessageHeader | | protected MessageHeaderEdit newMessageHeader(Message msg, MessageHeader other)(Code) | | Construct a new message header as a copy of another.
Parameters:
other - The other header to copy. The new message header. |
| newResource | | public Entity newResource(Entity container, String id, Object[] others)(Code) | | Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. The new resource. |
| newResource | | public Entity newResource(Entity container, Element element)(Code) | | Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. The new resource from the XML. |
| newResource | | public Entity newResource(Entity container, Entity other)(Code) | | Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. The new resource as a copy of the other. |
| newResourceEdit | | public Edit newResourceEdit(Entity container, String id, Object[] others)(Code) | | Construct a new rsource given just an id.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
id - The id for the new object.
Parameters:
others - (options) array of objects to load into the Resource's fields. The new resource. |
| newResourceEdit | | public Edit newResourceEdit(Entity container, Element element)(Code) | | Construct a new resource, from an XML element.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
element - The XML. The new resource from the XML. |
| newResourceEdit | | public Edit newResourceEdit(Entity container, Entity other)(Code) | | Construct a new resource from another resource of the same type.
Parameters:
container - The Resource that is the container for the new resource (may be null).
Parameters:
other - The other resource. The new resource as a copy of the other. |
| serviceName | | protected String serviceName()(Code) | | Report the Service API name being implemented.
|
| storageFields | | public Object[] storageFields(Entity r)(Code) | | Collect the fields that need to be stored outside the XML (for the resource).
An array of field values to store in the record outside the XML (for the resource). |
| willArchiveMerge | | public boolean willArchiveMerge()(Code) | | |
| Methods inherited from org.sakaiproject.message.impl.BaseMessageService | public MessageChannelEdit addChannel(String ref) throws IdUsedException, IdInvalidException, PermissionException(Code)(Java Doc)
public boolean allowAddChannel(String ref)(Code)(Java Doc)
public boolean allowEditChannel(String ref)(Code)(Java Doc)
public boolean allowGetChannel(String ref)(Code)(Java Doc)
protected boolean allowGetMessage(String channelRef, String msgRef)(Code)(Java Doc)
public boolean allowRemoveChannel(String ref)(Code)(Java Doc)
public String archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)(Code)(Java Doc)
public void archiveSynopticOptions(String siteId, Document doc, Element element)(Code)(Java Doc)
public void cancelChannel(MessageChannelEdit edit)(Code)(Java Doc)
public void cancelMessage(MessageEdit edit)(Code)(Java Doc)
public String channelReference(String context, String id)(Code)(Java Doc)
public void commitChannel(MessageChannelEdit edit)(Code)(Java Doc)
public void destroy()(Code)(Java Doc)
protected void disableMessageChannel(String siteId)(Code)(Java Doc)
public MessageChannelEdit editChannel(String ref) throws IdUnusedException, PermissionException, InUseException(Code)(Java Doc)
protected void enableMessageChannel(String siteId)(Code)(Java Doc)
abstract protected String eventId(String secure)(Code)(Java Doc)
protected MessageChannel findChannel(String ref)(Code)(Java Doc)
protected String getAccessPoint(boolean relative)(Code)(Java Doc)
public MessageChannel getChannel(String ref) throws IdUnusedException, PermissionException(Code)(Java Doc)
public List getChannelIds(String context)(Code)(Java Doc)
public List getChannels()(Code)(Java Doc)
public Entity getEntity(Reference ref)(Code)(Java Doc)
public Collection getEntityAuthzGroups(Reference ref, String userId)(Code)(Java Doc)
public String getEntityDescription(Reference ref)(Code)(Java Doc)
public ResourceProperties getEntityResourceProperties(Reference ref)(Code)(Java Doc)
public String getEntityUrl(Reference ref)(Code)(Java Doc)
public HttpAccess getHttpAccess()(Code)(Java Doc)
public Message getMessage(Reference ref) throws IdUnusedException, PermissionException(Code)(Java Doc)
public List getMessages(String channelRef, Time afterDate, int limitedToLatest, boolean ascending, boolean includeDrafts, boolean pubViewOnly) throws PermissionException(Code)(Java Doc)
abstract protected String getReferenceRoot()(Code)(Java Doc)
public Map getSummary(String channel, int items, int days) throws org.sakaiproject.exception.IdUsedException, org.sakaiproject.exception.IdInvalidException, org.sakaiproject.exception.PermissionException(Code)(Java Doc)
protected String getSummaryFromHeader(Message item, MessageHeader header)(Code)(Java Doc)
public void init()(Code)(Java Doc)
public String merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)(Code)(Java Doc)
public String messageReference(String context, String channelId, String id)(Code)(Java Doc)
public String messageReference(String channelRef, String id)(Code)(Java Doc)
abstract protected MessageHeaderEdit newMessageHeader(Message msg, String id)(Code)(Java Doc)
abstract protected MessageHeaderEdit newMessageHeader(Message msg, Element el)(Code)(Java Doc)
abstract protected MessageHeaderEdit newMessageHeader(Message msg, MessageHeader other)(Code)(Java Doc)
abstract protected Storage newStorage()(Code)(Java Doc)
protected void parseMergeChannelExtra(Element element3, String channelRef)(Code)(Java Doc)
public Object refresh(Object key, Object oldValue, Event event)(Code)(Java Doc)
public void removeChannel(MessageChannelEdit channel) throws PermissionException(Code)(Java Doc)
protected BaseMessageService service()(Code)(Java Doc)
abstract protected String serviceName()(Code)(Java Doc)
public void setAuthzGroupService(AuthzGroupService service)(Code)(Java Doc)
public void setCaching(String value)(Code)(Java Doc)
public void setEntityManager(EntityManager service)(Code)(Java Doc)
public void setEventTrackingService(EventTrackingService service)(Code)(Java Doc)
public void setIdManager(IdManager service)(Code)(Java Doc)
public void setMemoryService(MemoryService service)(Code)(Java Doc)
public void setSecurityService(SecurityService service)(Code)(Java Doc)
public void setServerConfigurationService(ServerConfigurationService service)(Code)(Java Doc)
public void setSessionManager(SessionManager service)(Code)(Java Doc)
public void setSiteService(SiteService service)(Code)(Java Doc)
public void setThreadLocalManager(ThreadLocalManager service)(Code)(Java Doc)
public void setTimeService(TimeService service)(Code)(Java Doc)
public void setUserDirectoryService(UserDirectoryService service)(Code)(Java Doc)
public void transferSynopticOptions(String fromContext, String toContext)(Code)(Java Doc)
protected void unlock(String lock, String resource) throws PermissionException(Code)(Java Doc)
protected void unlock2(String lock1, String lock2, String resource) throws PermissionException(Code)(Java Doc)
protected void unlock3(String lock1, String lock2, String lock3, String resource) throws PermissionException(Code)(Java Doc)
protected boolean unlockCheck(String lock, String resource)(Code)(Java Doc)
protected boolean unlockCheck2(String lock1, String lock2, String resource)(Code)(Java Doc)
protected boolean unlockCheck3(String lock1, String lock2, String lock3, String resource)(Code)(Java Doc)
public boolean willArchiveMerge()(Code)(Java Doc)
|
|
|