oracle.epm.fm.domainobject.applicationparameter

Class ApplicationParameterOM

java.lang.Object

oracle.epm.fm.domainobject.applicationparameter.ApplicationParameterOM

All Implemented Interfaces:

Serializable

public class ApplicationParameterOM
extends Object
implements Serializable

This class contains all ApplicationParameter related APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationParameterOM(SessionInfo sessionInfo) Creates an instance of the Application Parameter OM object.

Method Summary

Modifier and Type	Method and Description
void	deleteJournalOrderCachedXfmParameter() Internal Use Only To delete an xfmparameter value for journal,used in jhat.
void	deleteUserParameter(String parameterKey) Delete a user parameter value that has been set for an application.
String	getUserParameter(String parameterKey) Gets a user parameter that has been set for an application.
byte[]	getUserParameterBasic(String appSessionID, String parameterKey) Gets a user parameter that has been set for an application.
void	setJournalOrderCachedXfmParameter() Internal Use Only To set an xfmparameter value for journal, used in jhat.
void	setUserParameter(String parameterKey, String value) Sets the value for a specified user paramater in an application.
void	setUserParameterBasic(String appSessionID, String parameterKey, byte[] value) Sets the value for a specified user paramater in an application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationParameterOM

public ApplicationParameterOM(SessionInfo sessionInfo)
                       throws HFMException

Creates an instance of the Application Parameter OM object.

Parameters:

sessionInfo - session information

Throws:

HFMException - ${link ErrorCodeConsts#FAILED_OM_INIT}

Method Detail

getUserParameterBasic

public byte[] getUserParameterBasic(String appSessionID,
                                    String parameterKey)
                             throws HFMException

Gets a user parameter that has been set for an application.

Parameters:

appSessionID - the application session id for the application where the value will be retirieved from

parameterKey - the paramater name that will be retrieved

Returns:

the value store in the applicaiton for the key, null if no value was stored

Throws:

HFMException - ErrorCodeConsts.UNABLE_TO_GET_APP_PARAM

setUserParameterBasic

public void setUserParameterBasic(String appSessionID,
                                  String parameterKey,
                                  byte[] value)
                           throws HFMException

Sets the value for a specified user paramater in an application.

Parameters:

appSessionID - The session id which corresponds to the application where the value will be set

parameterKey - The key that will map to the value being saved in the application

value - The value that will be saved at the specified key in the application

Throws:

HFMException - ErrorCodeConsts.UNABLE_TO_SET_APP_PARAM

getUserParameter

public String getUserParameter(String parameterKey)
                        throws HFMException

Gets a user parameter that has been set for an application.

Parameters:

parameterKey - the paramater name that will be retrieved

Returns:

the value store in the applicaiton for the key, null if no value was stored

Throws:

HFMException - ErrorCodeConsts.UNABLE_TO_GET_APP_PARAM

setUserParameter

public void setUserParameter(String parameterKey,
                             String value)
                      throws HFMException

Sets the value for a specified user paramater in an application.

Parameters:

parameterKey - The key that will map to the value being saved in the application

value - The value that will be saved at the specified key in the application

Throws:

HFMException - ErrorCodeConsts.UNABLE_TO_SET_APP_PARAM

deleteUserParameter

public void deleteUserParameter(String parameterKey)
                         throws HFMException

Delete a user parameter value that has been set for an application.

Parameters:

parameterKey - the paramater name that will be deleted

Throws:

HFMException

setJournalOrderCachedXfmParameter

public void setJournalOrderCachedXfmParameter()
                                       throws HFMException

Internal Use Only To set an xfmparameter value for journal, used in jhat.

Throws:

HFMException

deleteJournalOrderCachedXfmParameter

public void deleteJournalOrderCachedXfmParameter()
                                          throws HFMException

Internal Use Only To delete an xfmparameter value for journal,used in jhat.

Throws:

HFMException