ContentBox Core API 1.6.0

contentbox.model.modules
Class Module

WEB-INF.cftags.component
        extended by contentbox.model.modules.Module

public class Module
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* I am a ContentBox Module

Property Summary
Type Property & Description Default Serializable Required
 any author


Attributes:
  • notnull = false
  • length = 255
true false
 any description


Attributes:
  • ormtype = text
  • notnull = false
  • length = 8000
true false
 any entryPoint


Attributes:
  • index = idx_entryPoint
  • notnull = false
  • length = 255
true false
 any forgeBoxSlug


Attributes:
  • notnull = false
  • length = 255
true false
 any isActive


Attributes:
  • index = idx_active
  • ormtype = boolean
  • notnull = true
  • dbdefault = 0
false true false
 any moduleID


Attributes:
  • generator = native
  • fieldtype = id
  • setter = false
true false
 any name


Attributes:
  • index = idx_moduleName
  • notnull = true
  • length = 255
true false
 any title


Attributes:
  • notnull = false
  • length = 255
true false
 any version


Attributes:
  • notnull = false
  • length = 255
0 true false
 any webURL


Attributes:
  • notnull = false
  • length = 500
true false
 
Method Summary
 any GETAUTHOR()
          get:
 any GETDESCRIPTION()
          get:
 any GETENTRYPOINT()
          get:
 any GETFORGEBOXSLUG()
          get:
 any GETISACTIVE()
          get:
 any GETMODULEID()
          get:
 any GETNAME()
          get:
 any GETTITLE()
          get:
 any GETVERSION()
          get:
 any GETWEBURL()
          get:
 Module SETAUTHOR(any author)
          set:
 Module SETDESCRIPTION(any description)
          set:
 Module SETENTRYPOINT(any entryPoint)
          set:
 Module SETFORGEBOXSLUG(any forgeBoxSlug)
          set:
 Module SETISACTIVE(any isActive)
          set:
 Module SETNAME(any name)
          set:
 Module SETTITLE(any title)
          set:
 Module SETVERSION(any version)
          set:
 Module SETWEBURL(any webURL)
          set:
 boolean checkForUpdates()
          Check for updates
 boolean isLoaded()
          is loaded?
 
Methods inherited from class WEB-INF.cftags.component
None
 

Property Detail

author

any author

Attributes:
serializable - true
required - false
notnull - false
length - 255
default -

description

any description

Attributes:
ormtype - text
serializable - true
required - false
notnull - false
length - 8000
default -

entryPoint

any entryPoint

Attributes:
index - idx_entryPoint
serializable - true
required - false
notnull - false
length - 255
default -

forgeBoxSlug

any forgeBoxSlug

Attributes:
serializable - true
required - false
notnull - false
length - 255
default -

isActive

any isActive

Attributes:
index - idx_active
ormtype - boolean
serializable - true
required - false
notnull - true
dbdefault - 0
default - false

moduleID

any moduleID

Attributes:
generator - native
fieldtype - id
serializable - true
required - false
default -
setter - false

name

any name

Attributes:
index - idx_moduleName
serializable - true
required - false
notnull - true
length - 255
default -

title

any title

Attributes:
serializable - true
required - false
notnull - false
length - 255
default -

version

any version

Attributes:
serializable - true
required - false
notnull - false
length - 255
default - 0

webURL

any webURL

Attributes:
serializable - true
required - false
notnull - false
length - 500
default -

Method Detail

GETAUTHOR

public any GETAUTHOR()
get:


GETDESCRIPTION

public any GETDESCRIPTION()
get:


GETENTRYPOINT

public any GETENTRYPOINT()
get:


GETFORGEBOXSLUG

public any GETFORGEBOXSLUG()
get:


GETISACTIVE

public any GETISACTIVE()
get:


GETMODULEID

public any GETMODULEID()
get:


GETNAME

public any GETNAME()
get:


GETTITLE

public any GETTITLE()
get:


GETVERSION

public any GETVERSION()
get:


GETWEBURL

public any GETWEBURL()
get:


SETAUTHOR

public Module SETAUTHOR(any author)
set:

Parameters:
author

SETDESCRIPTION

public Module SETDESCRIPTION(any description)
set:

Parameters:
description

SETENTRYPOINT

public Module SETENTRYPOINT(any entryPoint)
set:

Parameters:
entryPoint

SETFORGEBOXSLUG

public Module SETFORGEBOXSLUG(any forgeBoxSlug)
set:

Parameters:
forgeBoxSlug

SETISACTIVE

public Module SETISACTIVE(any isActive)
set:

Parameters:
isActive

SETNAME

public Module SETNAME(any name)
set:

Parameters:
name

SETTITLE

public Module SETTITLE(any title)
set:

Parameters:
title

SETVERSION

public Module SETVERSION(any version)
set:

Parameters:
version

SETWEBURL

public Module SETWEBURL(any webURL)
set:

Parameters:
webURL

checkForUpdates

public boolean checkForUpdates()
Check for updates


isLoaded

public boolean isLoaded()
is loaded?


ContentBox Core API 1.6.0