|
Oracle Collaboration Suite Discussions Java API Reference 10g (10.1.1) Part No. B16232-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.mail.Folder
oracle.mail.sdk.esmail.OracleFolder
oracle.mail.sdk.esmail.OracleSharedFolder
oracle.discussions.sdk.TdContainer
oracle.discussions.sdk.TdFacility
This class represents a Facility container. Facilities can contain other Facilities or message Boards.
Oracle discussions elements names have been changed in the webui compared to that of sdk portion. The existing names to the new names mapping is as shown.
TdContainer.java
, TdBoard.java
Nested Class Summary |
Nested classes inherited from class oracle.mail.sdk.esmail.OracleFolder |
oracle.mail.sdk.esmail.OracleFolder.OracleFlag |
Nested classes inherited from class javax.mail.UIDFolder |
javax.mail.UIDFolder.FetchProfileItem |
Field Summary |
Fields inherited from class oracle.discussions.sdk.TdContainer |
TD_BOARD, TD_FACILITY |
Fields inherited from class javax.mail.Folder |
HOLDS_FOLDERS, HOLDS_MESSAGES, READ_ONLY, READ_WRITE |
Fields inherited from interface javax.mail.UIDFolder |
LASTUID |
Constructor Summary | |
TdFacility(oracle.mail.sdk.esmail.OracleStore admstore, oracle.mail.sdk.esmail.OracleStore usrstore, oracle.discussions.sdk.impl.TdSession tdsession, java.lang.String folderName, long lFolderId, java.lang.String nameSpace) Constructor to create an instance of the TdFacility. |
Method Summary | |
TdBoard |
createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription) Creates a Board under this facility. |
TdBoard |
createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail) Creates a Board under this facility. |
TdBoard |
createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic) Creates a Board under this facility. |
TdBoard |
createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic, boolean bWithAnnouncementsBoard) Creates a Board under this facility. |
TdFacility |
createFacility(java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription) Creates a new TdFacility in this message store. |
TdFacility |
createFacility(java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription, boolean bWithAnnouncementsBoard) Creates a new TdFacility in this message store. |
void |
delete() Deletes this TdFacility in this message store - child facilities boards and messages will be deleted too. |
void |
deleteBoard(TdBoard tdb) Deletes a Board under this facility. |
int |
getContainerType() Returns the container type on which this method is invoked. |
int |
getMessageCount() Returns the number of messsages in ths container. |
int |
getNewMessageCount() Returns the number of new messsages in ths container. |
int |
getUnreadMessageCount() Returns the number of unread messsages in ths container. |
void |
grantBoardCreator(TdUser tdUser) Grants BoardCreator role to the supplied user for this facility. |
void |
grantFacilityAdmin(TdUser tdUser) Grants FacilityAdmin role to the supplied user for this facility. |
void |
grantFacilityCreator(TdUser tdUser) Grants FacilityCreator role to the supplied user for this facility |
void |
grantFacilityReader(TdUser tdUser) Grants FacilityReader role to the supplied user for this facility. |
void |
grantFacilityWriter(TdUser tdUser) Grants FacilityWriter role to the supplied user for this facility |
boolean |
hasNewMessages() Returns if the container has new messages |
void |
revokeBoardCreator(TdUser tdUser) Revokes BoardCreator role to the supplied user for this facility. |
void |
revokeFacilityAdmin(TdUser tdUser) Revokes FacilityAdmin role to the supplied user for this facility. |
void |
revokeFacilityCreator(TdUser tdUser) Revokes FacilityCreator role to the supplied user for this facility. |
void |
revokeFacilityReader(TdUser tdUser) Grants FacilityReader role to the supplied user for this facility. |
void |
revokeFacilityWriter(TdUser tdUser) Revokes FacilityWriter role to the supplied user for this facility. |
Methods inherited from class oracle.mail.sdk.esmail.OracleSharedFolder |
_setFlags, getNamespace, hasDigitPermission |
Methods inherited from class oracle.mail.sdk.esmail.OracleFolder |
_doSearch, addACI, addACI, appendMessages, convertFlag, convertFlag, convertUsrFlag, getCounts, getFolderExpiry, getFolderId, getFolderSize, getFolderSize, getFullName, getFullPath, getName, getSeparator, getType, getURLName, isInheritedACI, removeACI, removeACI, setFolderExpiry |
Methods inherited from class javax.mail.Folder |
addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, getDeletedMessageCount, getMode, getStore, listSubscribed, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, toString |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TdFacility(oracle.mail.sdk.esmail.OracleStore admstore, oracle.mail.sdk.esmail.OracleStore usrstore, oracle.discussions.sdk.impl.TdSession tdsession, java.lang.String folderName, long lFolderId, java.lang.String nameSpace)
admstore
- Oracle email administrator storeusrstore
- Orace email user storetdsession
- oracle discussions session for this instance of discussionslFolderId
- Oracle email shared folder idMethod Detail |
public int getContainerType()
getContainerType
in class TdContainer
public void grantFacilityAdmin(TdUser tdUser) throws TdException
tdUser
- discussions user to whom facility administrator role is being granted.TdException
public void grantFacilityWriter(TdUser tdUser) throws TdException
tdException
TdException
public void grantFacilityCreator(TdUser tdUser) throws TdException
TdException
public void grantBoardCreator(TdUser tdUser) throws TdException
tdUser
- discussions user to whom forum creator role is being grantedTdException
public void grantFacilityReader(TdUser tdUser) throws TdException
tdUser
- discussions user to whom category reader role is being granted.TdException
public void revokeFacilityAdmin(TdUser tdUser) throws TdException
tdUser
- category user who is being removed from the category admin roleTdException
public void revokeBoardCreator(TdUser tdUser) throws TdException
tdUser
- discussions user who is being removed from forum creator roleTdException
public void revokeFacilityWriter(TdUser tdUser) throws TdException
tdUser
- discussions user who is being removed from category writer roleTdException
public void revokeFacilityCreator(TdUser tdUser) throws TdException
tdUser
- discussions user who is being revoked from category creatorTdException
public void revokeFacilityReader(TdUser tdUser) throws TdException
tdUser
- discussions user who is being revoked from category reader roleTdException
public TdBoard createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription) throws TdException
boardName
- forum name which is being created.boardDisplayName
- display name for the forumboardDescription
- forum descriptionTdException
public TdBoard createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail) throws TdException
boardName
- forum name which is being created.boardDisplayName
- display name for the forumboardDescription
- forum descriptionboardEmail
- email address of the forumTdException
public TdBoard createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic) throws TdException
boardName
- forum name which is being created.boardDisplayName
- display name for the forumboardDescription
- forum descriptionboardEmail
- email address of the forumisPublic
- boolean variable indicating if the forum is publicTdException
public TdBoard createBoard(java.lang.String boardName, java.lang.String boardDisplayName, java.lang.String boardDescription, java.lang.String boardEmail, boolean isPublic, boolean bWithAnnouncementsBoard) throws TdException
boardName
- forum name which is being created.boardDisplayName
- display name for the forumboardDescription
- forum descriptionboardEmail
- email address of the forumisPublic
- boolean variable indicating if the forum is publicTdException
public void deleteBoard(TdBoard tdb) throws TdException
tdb
- the forum that is to be deleted.TdException
public TdFacility createFacility(java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription) throws TdException
facilityName
- name of the category being createdfacilityDisplayName
- display name of the category being createdfacilityDescription
- description of the category being created.TdException
public TdFacility createFacility(java.lang.String facilityName, java.lang.String facilityDisplayName, java.lang.String facilityDescription, boolean bWithAnnouncementsBoard) throws TdException
facilityName
- name of the category being createdfacilityDisplayName
- display name of the category being createdfacilityDescription
- description of the category being created.bWithAnnouncementsBoard
- boolean value indicating if the announcements board will be created automatically.TdException
public int getMessageCount() throws javax.mail.MessagingException
javax.mail.MessagingException
- since facility cant hold messagespublic int getNewMessageCount() throws javax.mail.MessagingException
javax.mail.MessagingException
- since facility cant hold messagespublic int getUnreadMessageCount() throws javax.mail.MessagingException
javax.mail.MessagingException
- since facility cant hold messagespublic boolean hasNewMessages() throws javax.mail.MessagingException
javax.mail.MessagingException
- since facility cant hold messagespublic void delete() throws TdException
delete
in class TdContainer
TdException
oracle.discussions.sdk.TdStore#deleteFacility
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |