com.flexive.shared.scripting
Class FxScriptInfo

java.lang.Object
  extended by com.flexive.shared.AbstractSelectableObjectWithName
      extended by 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  java.lang.String code
           
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, java.lang.String code, boolean active)
          Constructor
 
Method Summary
 FxScriptInfoEdit asEditable()
          Return this script info as editable object.
 java.lang.String getCode()
          Get the scripts code
 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.
 
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

code

protected java.lang.String code

active

protected boolean active
Constructor Detail

FxScriptInfo

public FxScriptInfo()

FxScriptInfo

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

Parameters:
id - script id
event - script type
name - (unique) name of the script
description - description
code - the script code
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

getCode

public java.lang.String getCode()
Get the scripts code

Returns:
code

isActive

public boolean isActive()
Returns if the script is set to active.

Returns:
active