com.ibm.commerce.contract.objimpl
Class BusinessPolicyBeanBase

java.lang.Object
  |
  +--com.ibm.commerce.base.objects.ECEntityBean
        |
        +--com.ibm.commerce.contract.objimpl.BusinessPolicyBeanBase
Direct Known Subclasses:
BusinessPolicyBean

public class BusinessPolicyBeanBase
extends com.ibm.commerce.base.objects.ECEntityBean

This bean provides access to the POLICY table.

The following is a description of this table:

Each row in this table represents a business policy.

See Also:
Serialized Form

Field Summary
 java.sql.Timestamp endDate
           
 java.lang.Long policyId
           
 java.lang.String policyName
           
 java.lang.String properties
           
 java.sql.Timestamp startDate
           
 java.lang.Integer storeEntityId
           
 java.lang.String type
           
 
Constructor Summary
BusinessPolicyBeanBase()
           
 
Method Summary
 com.ibm.commerce.contract.objects.BusinessPolicyKey ejbCreate(java.lang.String argPolicyName, java.lang.String argType, java.lang.Integer argStoreEntityId)
          Constructs an BusinessPolicyAccessBean object with the specified policy name, policy type, and the store entity ID.
  PolicyDescriptionAccessBean getDescription(java.lang.Integer argLanguageId)
          Retrieves the PolicyDescriptionAccessBean representing the business policy description with the specified language ID.
  PolicyDescriptionAccessBean getDescription(java.lang.Integer language_id, java.lang.Integer storeId)
          Retrieves the PolicyDescriptionAccessBean representing the business policy description with the specified language ID.
 java.sql.Timestamp getEndDate()
          This method provides access to the POLICY.ENDTIME column of DB2 type TIMESTAMP NULL.
protected  java.lang.Object getFallbackDescription(java.lang.Integer languageId)
          Retrieves the PolicyDescriptionAccessBean representing the business policy description with the specified language ID.
 java.lang.Long getPolicyId()
          This method provides access to the POLICY.POLICY_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getPolicyName()
          This method provides access to the POLICY.POLICYNAME column of DB2 type VARCHAR(128) NOT NULL.
 java.lang.String getProperties()
          This method provides access to the POLICY.PROPERTIES column of DB2 type VARCHAR(254) NULL.
 java.sql.Timestamp getStartDate()
          This method provides access to the POLICY.STARTTIME column of DB2 type TIMESTAMP NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the POLICY.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getType()
          This method provides access to the POLICY.POLICYTYPE_ID column of DB2 type CHAR(64) NOT NULL.
 void setEndDate(java.sql.Timestamp newValue)
          This method provides access to the POLICY.ENDTIME column of DB2 type TIMESTAMP NULL.
 void setPolicyId(java.lang.Long newPolicyId)
          This method provides access to the POLICY.POLICY_ID column of DB2 type BIGINT NOT NULL.
 void setPolicyName(java.lang.String newValue)
          This method provides access to the POLICY.POLICYNAME column of DB2 type VARCHAR(128) NOT NULL.
 void setProperties(java.lang.String newValue)
          This method provides access to the POLICY.PROPERTIES column of DB2 type VARCHAR(254) NULL.
 void setStartDate(java.sql.Timestamp newValue)
          This method provides access to the POLICY.STARTTIME column of DB2 type TIMESTAMP NULL.
 void setStoreEntityId(java.lang.Integer newStoreEntityId)
          This method provides access to the POLICY.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setType(java.lang.String newValue)
          This method provides access to the POLICY.POLICYTYPE_ID column of DB2 type CHAR(64) NOT NULL.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

policyId

public java.lang.Long policyId

policyName

public java.lang.String policyName

type

public java.lang.String type

storeEntityId

public java.lang.Integer storeEntityId

properties

public java.lang.String properties

startDate

public java.sql.Timestamp startDate

endDate

public java.sql.Timestamp endDate
Constructor Detail

BusinessPolicyBeanBase

public BusinessPolicyBeanBase()
Method Detail

ejbCreate

public com.ibm.commerce.contract.objects.BusinessPolicyKey ejbCreate(java.lang.String argPolicyName,
                                                                     java.lang.String argType,
                                                                     java.lang.Integer argStoreEntityId)
                                                              throws javax.ejb.CreateException,
                                                                     javax.ejb.FinderException,
                                                                     javax.naming.NamingException

Constructs an BusinessPolicyAccessBean object with the specified policy name, policy type, and the store entity ID.

Parameters:
argPolicyName - The name of the business policy.
argType - The type of the business policy.
argStoreEntityId - The ID of store entity.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

getDescription

public PolicyDescriptionAccessBean getDescription(java.lang.Integer argLanguageId)
                                           throws javax.ejb.CreateException,
                                                  javax.ejb.FinderException,
                                                  javax.naming.NamingException

Retrieves the PolicyDescriptionAccessBean representing the business policy description with the specified language ID.

Parameters:
argLanguageId - The ID of the language.
Returns:
The business policy description in the specified language.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

getDescription

public PolicyDescriptionAccessBean getDescription(java.lang.Integer language_id,
                                                  java.lang.Integer storeId)
                                           throws javax.ejb.CreateException,
                                                  javax.ejb.FinderException,
                                                  javax.naming.NamingException

Retrieves the PolicyDescriptionAccessBean representing the business policy description with the specified language ID. If the description for the specified language is not available for the specified store, An alternate language description will be returned.

Parameters:
language_id - The ID of the language.
storeId - The ID of the store.
Returns:
The business policy description in the specified language.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

getEndDate

public java.sql.Timestamp getEndDate()

This method provides access to the POLICY.ENDTIME column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

End date of the policy. If null, no end time.

Returns:
The ending date of the business policy.

getFallbackDescription

protected java.lang.Object getFallbackDescription(java.lang.Integer languageId)
                                           throws javax.ejb.CreateException,
                                                  javax.ejb.FinderException,
                                                  javax.naming.NamingException

Retrieves the PolicyDescriptionAccessBean representing the business policy description with the specified language ID.

Returns:
The business policy description in the specified language.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception.
javax.ejb.FinderException - The javax.ejb.FinderException exception.
javax.naming.NamingException - The javax.naming.NamingException exception.

getPolicyId

public java.lang.Long getPolicyId()

This method provides access to the POLICY.POLICY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The policy ID.

Returns:
The ID of the business policy.

getPolicyName

public java.lang.String getPolicyName()

This method provides access to the POLICY.POLICYNAME column of DB2 type VARCHAR(128) NOT NULL.

The following is a description of this column:

The policy unique name. It is expected that a store contains the following bootstrap policies:

MasterCatalog (one per storeEntity), CreditLine (one per storeEntity).

Returns:
The name of the business policy.

getProperties

public java.lang.String getProperties()

This method provides access to the POLICY.PROPERTIES column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

Default name value pairs that can be set to the business policy command. For example: n1=v1&n2=v2.

Returns:
The properties of the business policy.

getStartDate

public java.sql.Timestamp getStartDate()

This method provides access to the POLICY.STARTTIME column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Start date of the policy. If null start immediately.

Returns:
The starting date of the business policy.

getStoreEntityId

public java.lang.Integer getStoreEntityId()

This method provides access to the POLICY.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Store or StoreGroup ID.

Returns:
The ID of the store entity.

getType

public java.lang.String getType()

This method provides access to the POLICY.POLICYTYPE_ID column of DB2 type CHAR(64) NOT NULL.

The following is a description of this column:

The policy type ID. Foreign key to the POLICYTYPE table.

Returns:
The type of the business policy.

setEndDate

public void setEndDate(java.sql.Timestamp newValue)

This method provides access to the POLICY.ENDTIME column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

End date of the policy. If null, no end time.

Parameters:
newValue - The ending date of the business policy.

setPolicyId

public void setPolicyId(java.lang.Long newPolicyId)

This method provides access to the POLICY.POLICY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The policy ID.

Parameters:
newPolicyId - The ID of the business policy.

setPolicyName

public void setPolicyName(java.lang.String newValue)

This method provides access to the POLICY.POLICYNAME column of DB2 type VARCHAR(128) NOT NULL.

The following is a description of this column:

The policy unique name. It is expected that a store contains the following bootstrap policies:

MasterCatalog (one per storeEntity), CreditLine (one per storeEntity).

Parameters:
newValue - The name of the business policy.

setProperties

public void setProperties(java.lang.String newValue)

This method provides access to the POLICY.PROPERTIES column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

Default name value pairs that can be set to the business policy command. For example: n1=v1&n2=v2.

Parameters:
newValue - The properties of the business policy.

setStartDate

public void setStartDate(java.sql.Timestamp newValue)

This method provides access to the POLICY.STARTTIME column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Start date of the policy. If null start immediately.

Parameters:
newValue - The starting date of the business policy.

setStoreEntityId

public void setStoreEntityId(java.lang.Integer newStoreEntityId)

This method provides access to the POLICY.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Store or StoreGroup ID.

Parameters:
newStoreEntityId - The ID of the store entity.

setType

public void setType(java.lang.String newValue)

This method provides access to the POLICY.POLICYTYPE_ID column of DB2 type CHAR(64) NOT NULL.

The following is a description of this column:

The policy type ID. Foreign key to the POLICYTYPE table.

Parameters:
newValue - The type of the business policy.