ContentBox Core API 1.6.0

contentbox.model.content
Class CustomField

WEB-INF.cftags.component
        extended by contentbox.model.content.CustomField

public class CustomField
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 custom field metadata that can be attached to base content in contentbox

Property Summary
Type Property & Description Default Serializable Required
 any customFieldID


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


Attributes:
  • ormtype = string
  • notnull = true
  • length = 255
true false
 any relatedContent


Attributes:
  • index = idx_contentCustomFields
  • fieldtype = many-to-one
  • notnull = false
  • lazy = true
  • cfc = contentbox.model.content.BaseContent
  • fkcolumn = FK_contentID
true false
 any value


Attributes:
  • ormtype = text
  • notnull = true
  • length = 8000
true false
 
Method Summary
 any GETCUSTOMFIELDID()
          get:
 any GETKEY()
          get:
 any GETRELATEDCONTENT()
          get:
 any GETVALUE()
          get:
 boolean HASRELATEDCONTENT()
 CustomField SETKEY(any key)
          set:
 CustomField SETRELATEDCONTENT(any relatedContent)
          set:
 CustomField SETVALUE(any value)
          set:
 any getMemento()
          Get memento representation
 boolean isLoaded()
          is loaded?
 
Methods inherited from class WEB-INF.cftags.component
None
 

Property Detail

customFieldID

any customFieldID

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

key

any key

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

relatedContent

any relatedContent

Attributes:
index - idx_contentCustomFields
fieldtype - many-to-one
serializable - true
required - false
notnull - false
lazy - true
cfc - contentbox.model.content.BaseContent
default -
fkcolumn - FK_contentID

value

any value

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

Method Detail

GETCUSTOMFIELDID

public any GETCUSTOMFIELDID()
get:


GETKEY

public any GETKEY()
get:


GETRELATEDCONTENT

public any GETRELATEDCONTENT()
get:


GETVALUE

public any GETVALUE()
get:


HASRELATEDCONTENT

public boolean HASRELATEDCONTENT()


SETKEY

public CustomField SETKEY(any key)
set:

Parameters:
key

SETRELATEDCONTENT

public CustomField SETRELATEDCONTENT(any relatedContent)
set:

Parameters:
relatedContent

SETVALUE

public CustomField SETVALUE(any value)
set:

Parameters:
value

getMemento

public any getMemento()
Get memento representation


isLoaded

public boolean isLoaded()
is loaded?


ContentBox Core API 1.6.0