com.aspc.cms.component

Class MenuItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.component.MenuItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

SubMenuItem

public class MenuItem
extends DBObject

The page menu item.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

4 December 2003

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID The page menu item
static java.lang.String	DBCLASS_NAME The page menu item

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
MenuItem(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static MenuItem	create(MutableDataSource mds) Make a new instance of this class.
protected void	extFixUp() The extended fix up routine
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreDeleteRecord() OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
static MenuItem	findKey(DataSource ds, int key) Find the target for this class by the primary key
MenuComponent	findMenu(java.lang.String... args) The page menu item.
Page	findPage(java.lang.String... args) the menu page.
java.lang.String	getDisplayTitle(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
MenuComponent	getMenu(java.lang.String... args)
Page	getPage(java.lang.String... args)
java.lang.String	getPageAnchorID(java.lang.String... args)
java.lang.String	getRawLink(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getStyleClass(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
static DBQuery<MenuItem>	makeQuery(DataSource ds) Make a new QUERY for this class.
MenuItem	setFinalFg(boolean value, java.lang.String... args)
MenuItem	setID(int value, java.lang.String... args)
MenuItem	setLabel(java.lang.String value, java.lang.String... args)
MenuItem	setMenu(com.aspc.dal.cms.component.MenuComponent value, java.lang.String... args)
MenuItem	setPage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
MenuItem	setPageAnchorID(java.lang.String value, java.lang.String... args)
MenuItem	setRawLink(java.lang.String value, java.lang.String... args)
MenuItem	setSequence(int value, java.lang.String... args)
MenuItem	setStyleClass(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

The page menu item

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The page menu item

Constructor Detail

MenuItem

public MenuItem(DBClass def,
                DataSource dataSource)
         throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public MenuItem setID(int value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayTitle

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayTitle(java.lang.String... args)

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public MenuItem setFinalFg(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getLabel

@CheckReturnValue
 @Nonnull
public java.lang.String getLabel(java.lang.String... args)

setLabel

@Nonnull
public MenuItem setLabel(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getMenu

@CheckReturnValue
 @Nullable
public MenuComponent getMenu(java.lang.String... args)

findMenu

@CheckReturnValue
 @Nonnull
public final MenuComponent findMenu(java.lang.String... args)
                                                         throws NotFoundException

The page menu item.

--> MenuComponent (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Menu

Throws:

NotFoundException - MenuComponent was not found

setMenu

@Nonnull
public MenuItem setMenu(com.aspc.dal.cms.component.MenuComponent value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getPage

@CheckReturnValue
 @Nullable
public Page getPage(java.lang.String... args)

findPage

@CheckReturnValue
 @Nonnull
public final Page findPage(java.lang.String... args)
                                                throws NotFoundException

the menu page.

--> SitePage (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setPage

@Nonnull
public MenuItem setPage(com.aspc.dal.cms.SitePage value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getPageAnchorID

@CheckReturnValue
 @Nonnull
public java.lang.String getPageAnchorID(java.lang.String... args)

setPageAnchorID

@Nonnull
public MenuItem setPageAnchorID(@MatchesPattern(value="[a-zA-Z][\\w:.-]*")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getRawLink

@CheckReturnValue
 @Nonnull
public java.lang.String getRawLink(java.lang.String... args)

setRawLink

@Nonnull
public MenuItem setRawLink(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

@CheckReturnValue
public int getSequence(java.lang.String... args)

setSequence

@Nonnull
public MenuItem setSequence(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getStyleClass

@CheckReturnValue
 @Nonnull
public java.lang.String getStyleClass(java.lang.String... args)

setStyleClass

@Nonnull
public MenuItem setStyleClass(@MatchesPattern(value="(-?[_a-zA-Z]+[_a-zA-Z0-9\\-]*| )*")
                                       java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static MenuItem create(@Nonnull
                                                          MutableDataSource mds)
                                                   throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<MenuItem> makeQuery(@Nonnull
                                                                      DataSource ds)
                                                               throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static MenuItem findKey(@Nonnull
                                                           DataSource ds,
                                                           int key)
                                                    throws NotFoundException,
                                                           java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

Description copied from class: DBObject

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extPreDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPreDeleteRecord()
                                                             throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreDeleteRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem