oracle.discussions.sdk
Interface TdContainerSettings

All Superinterfaces:

java.util.Map

All Known Subinterfaces:

TdBoardSettings

public interface TdContainerSettings

extends java.util.Map

ContainerSettings represent the attributes defined when the container is created.

They are common to both the facility and board.
These settings define the

• Description of the Container
• Display Name of the Container
• and ther properties.
  They can be configured and edited by the creator of the container or any user with the role higher than or equivalent to that.
  

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.

• Facility - Category
• Board - Forum
• Delete - Hide

Sample code snippet illustrating the usage of TdContainerSettings

  //Declare a containersettings object
  TdContainerSettings tdcs = tdf.getContainerSettings();
  //Initialize different fields in the container settings instance.
  tdcs.put(TdContainerSettingsImpl.CREATOR_GUID, tdsession.getTdUser().getUserGuid());
  java.util.Date dNow = new java.util.Date();
  java.util.Date dNowGMT = DateUtils.convertToGMT( new Timestamp(dNow.getTime()));
  tdcs.put(TdContainerSettingsImpl.CREATION_DATE, String.valueOf(dNowGMT.getTime()));
  tdcs.put(TdContainerSettings.DISPLAY_NAME, facilityDispName);
  tdcs.put(TdContainerSettings.DESCRIPTION, facilityDescription);
 

Since:

OCS 10.1.1

See Also:

TdContainer.java, TdBoardSettings.java

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Field Summary

static java.lang.String	DESCRIPTION Specifies the description for the container.
static java.lang.String	DISPLAY_NAME Specifies the display name for the container.
static int	UNDEFINED_INT_SETTINGS Specifies that none os the settings are defined.

Method Summary

java.util.Map	currents() Returns all the current keys with a value without returning the defaults
void	setDescription(java.lang.String description) Sets the description for this container
void	setDisplayName(java.lang.String displayName) Sets the display name for this container
void	validate() Validates the value of the parameters currently set in this container settings instance.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Field Detail

UNDEFINED_INT_SETTINGS

public static final int UNDEFINED_INT_SETTINGS

Specifies that none os the settings are defined.

See Also:

Constant Field Values

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME

Specifies the display name for the container.

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

Specifies the description for the container.

See Also:

Constant Field Values

Method Detail

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws TdException

Sets the display name for this container

Parameters:

displayName - the string used to set the display name for the container.

Throws:

TdException

setDescription

public void setDescription(java.lang.String description)
                    throws TdException

Sets the description for this container

Parameters:

description - the string used to set the description to the container

Throws:

TdException

currents

public java.util.Map currents()

Returns all the current keys with a value without returning the defaults

Returns:

Map

validate

public void validate()
              throws TdException

Validates the value of the parameters currently set in this container settings instance.

Throws:

TdException - if a parameter has an invalid value