com.flexive.shared.scripting
Class FxScriptInfo

java.lang.Object
  com.flexive.shared.AbstractSelectableObjectWithName
      com.flexive.shared.scripting.FxScriptInfo

All Implemented Interfaces:

SelectableObject, SelectableObjectWithName, java.io.Serializable

Direct Known Subclasses:

FxScriptInfoEdit

public class FxScriptInfo
extends AbstractSelectableObjectWithName
implements java.io.Serializable

Information about a script

Author:

Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

See Also:

Serialized Form

Field Summary

protected boolean	active
protected boolean	cached
protected java.lang.String	description
protected FxScriptEvent	event
protected long	id
protected java.lang.String	name

Constructor Summary

FxScriptInfo()

FxScriptInfo(long id, FxScriptEvent event, java.lang.String name, java.lang.String description, boolean active)
Deprecated. use FxScriptInfo(long, FxScriptEvent, String, String, boolean, boolean) instead

FxScriptInfo(long id, FxScriptEvent event, java.lang.String name, java.lang.String description, boolean active, boolean cached)
Constructor

Method Summary

FxScriptInfoEdit	asEditable() Return this script info as editable object.
java.lang.String	getDescription() Get the description of this script
FxScriptEvent	getEvent() Get the event type of this script
long	getId() Get the id of this script
java.lang.String	getName() Get the (unique) name of this script
boolean	isActive() Returns if the script is set to active.
boolean	isCached() Returns if the script is cached.

Methods inherited from class com.flexive.shared.AbstractSelectableObjectWithName

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

id

protected long id

event

protected FxScriptEvent event

name

protected java.lang.String name

description

protected java.lang.String description

active

protected boolean active

cached

protected boolean cached

Constructor Detail

FxScriptInfo

public FxScriptInfo()

FxScriptInfo

public FxScriptInfo(long id,
                    FxScriptEvent event,
                    java.lang.String name,
                    java.lang.String description,
                    boolean active,
                    boolean cached)
             throws FxInvalidParameterException

Constructor

Parameters:

id - script id

event - script type

name - (unique) name of the script

description - description

active - if the script is active

cached - if the script is cached

Throws:

FxInvalidParameterException - on errors

Since:

3.1.1

See Also:

FxScriptEvent

FxScriptInfo

@Deprecated
public FxScriptInfo(long id,
                               FxScriptEvent event,
                               java.lang.String name,
                               java.lang.String description,
                               boolean active)
             throws FxInvalidParameterException

Deprecated. use FxScriptInfo(long, FxScriptEvent, String, String, boolean, boolean) instead

Constructor

Parameters:

id - script id

event - script type

name - (unique) name of the script

description - description

active - if the script is active

Throws:

FxInvalidParameterException - on errors

See Also:

FxScriptEvent

Method Detail

asEditable

public FxScriptInfoEdit asEditable()

Return this script info as editable object.

Returns:

script info as editable

getId

public long getId()

Get the id of this script

Specified by:

getId in interface SelectableObject

Returns:

id of this script

getEvent

public FxScriptEvent getEvent()

Get the event type of this script

Returns:

event type of this script

See Also:

FxScriptEvent

getName

public java.lang.String getName()

Get the (unique) name of this script

Specified by:

getName in interface SelectableObjectWithName

Returns:

name of this script

getDescription

public java.lang.String getDescription()

Get the description of this script

Returns:

description of this script

isActive

public boolean isActive()

Returns if the script is set to active.

Returns:

active

isCached

public boolean isCached()

Returns if the script is cached.

Returns:

cached

Since:

3.1.1