|
Oracle Discussions Java API Reference 10g Release 1 (10.1.2) B25496-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
, TdBoard
Field Summary | |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsCreateBoard |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsCreateFacility |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsDelete |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsDeleteBoard |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantBoardCreator |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantFacilityAdmin |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantFacilityCreator |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantFacilityReader |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsGrantFacilityWriter |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeBoardCreator |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeFacilityAdmin |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeFacilityCreator |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeFacilityReader |
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent |
s_dmsRevokeFacilityWriter |
protected static oracle.dms.instrument.Noun |
s_nFacility |
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 |
protected void |
refreshPermissions() Refreshes cached permissions on facility level. |
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. |
Field Detail |
protected static oracle.dms.instrument.Noun s_nFacility
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsCreateBoard
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsCreateFacility
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsDelete
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsDeleteBoard
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantFacilityReader
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantFacilityWriter
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantFacilityAdmin
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantFacilityCreator
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsGrantBoardCreator
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeFacilityAdmin
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeFacilityReader
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeFacilityWriter
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeBoardCreator
protected static oracle.discussions.sdk.impl.data.dms.TdPhaseEvent s_dmsRevokeFacilityCreator
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 storefolderName
- Name of the facility being created.tdsession
- oracle discussions session for this instance of discussionslFolderId
- Oracle email shared folder idnameSpace
- email namespace in which the sharedfolder is created.Method Detail |
public int getContainerType()
protected void refreshPermissions() throws TdException
public void grantFacilityAdmin(TdUser tdUser) throws TdException
tdUser
- discussions user to whom facility administrator role is being granted.public void grantFacilityWriter(TdUser tdUser) throws TdException
tdUser
- discussions user to whom category writer role is being granted.public void grantFacilityCreator(TdUser tdUser) throws TdException
tdUser
- discussions user to whom category creator role is being created.public void grantBoardCreator(TdUser tdUser) throws TdException
tdUser
- discussions user to whom forum creator role is being grantedpublic void grantFacilityReader(TdUser tdUser) throws TdException
tdUser
- discussions user to whom category reader role is being granted.public void revokeFacilityAdmin(TdUser tdUser) throws TdException
tdUser
- category user who is being removed from the category admin rolepublic void revokeBoardCreator(TdUser tdUser) throws TdException
tdUser
- discussions user who is being removed from forum creator rolepublic void revokeFacilityWriter(TdUser tdUser) throws TdException
tdUser
- discussions user who is being removed from category writer rolepublic void revokeFacilityCreator(TdUser tdUser) throws TdException
tdUser
- discussions user who is being revoked from category creatorpublic void revokeFacilityReader(TdUser tdUser) throws TdException
tdUser
- discussions user who is being revoked from category reader rolepublic 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 descriptionpublic 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 forumpublic 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 publicpublic 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 publicbWithAnnouncementsBoard
- boolean value indicating if the announcements board will be created automatically.public void deleteBoard(TdBoard tdb) throws TdException
tdb
- the forum that is to be deleted.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.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.public int getMessageCount() throws javax.mail.MessagingException
public int getNewMessageCount() throws javax.mail.MessagingException
public int getUnreadMessageCount() throws javax.mail.MessagingException
public boolean hasNewMessages() throws javax.mail.MessagingException
public void delete() throws TdException
|
Oracle Discussions Java API Reference 10g Release 1 (10.1.2) B25496-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |