ContentBox Core API 1.5.7

contentbox.model.security
Class Author

WEB-INF.cftags.component
        extended by contentbox.model.security.Author

public class Author
extends WEB-INF.cftags.component

I am a author entity


Constructor Summary
init()
          Constructor
 
Method Summary
 void ADDENTRY(Entry entry)
 void ADDPAGE(Page page)
 void ADDPERMISSION(Permission permission)
 any GETAUTHORID()
 any GETAUTHORSERVICE()
 any GETBIOGRAPHY()
 any GETCREATEDDATE()
 any GETEMAIL()
 array GETENTRIES()
 any GETFIRSTNAME()
 any GETISACTIVE()
 any GETLASTLOGIN()
 any GETLASTNAME()
 boolean GETLOGGEDIN()
 any GETNUMBEROFENTRIES()
 any GETNUMBEROFPAGES()
 array GETPAGES()
 any GETPASSWORD()
 any GETPERMISSIONLIST()
 array GETPERMISSIONS()
 any GETPREFERENCES()
 any GETROLE()
 any GETUSERNAME()
 boolean HASENTRY([Entry entries])
 boolean HASPAGE([Page pages])
 boolean HASPERMISSION([Permission permissions])
 boolean HASROLE()
 boolean REMOVEENTRY(Entry entry)
 boolean REMOVEPAGE(Page page)
 boolean REMOVEPERMISSION(Permission permission)
 void SETAUTHORSERVICE(any authorService)
 void SETBIOGRAPHY(any biography)
 void SETCREATEDDATE(any createdDate)
 void SETEMAIL(any email)
 void SETENTRIES(array entries)
 void SETFIRSTNAME(any firstName)
 void SETISACTIVE(any isActive)
 void SETLASTLOGIN(any lastLogin)
 void SETLASTNAME(any lastName)
 void SETLOGGEDIN(boolean loggedIn)
 void SETNUMBEROFENTRIES(any numberOfEntries)
 void SETNUMBEROFPAGES(any numberOfPages)
 void SETPAGES(array pages)
 void SETPASSWORD(any password)
 void SETPERMISSIONLIST(any permissionList)
 void SETROLE(any role)
 void SETUSERNAME(any username)
 boolean checkPermission(any slug)
          Check for permission
 Author clearPermissions()
          Clear all permissions
 struct getAllPreferences()
          Get all user preferences in inflated format
 string getDisplayCreatedDate()
          Get formatted createdDate
 string getDisplayLastLogin()
          Get formatted lastLogin
 any getMemento()
          Get a flat representation of this entry
 string getName()
          Retrieve full name
 any getPreference(any name, [any defaultValue])
          Get a preference, you can pass a default value if preference does not exist
 any inPermissionList(any list)
          Verify that a passed in list of perms the user can use
 boolean isLoaded()
          is loaded?
 any isLoggedIn()
          Logged in
 void preInsert()
 Author setPermissions(array permissions)
          Override the setPermissions
 Author setPreference(any name, any value)
          Set a preference in the user preferences
 Author setPreferences(any preferences)
          Store a preferences structure or JSON data in the user prefernces
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
Constructor

Method Detail

ADDENTRY

public void ADDENTRY(Entry entry)

Parameters:
entry

ADDPAGE

public void ADDPAGE(Page page)

Parameters:
page

ADDPERMISSION

public void ADDPERMISSION(Permission permission)

Parameters:
permission

GETAUTHORID

public any GETAUTHORID()


GETAUTHORSERVICE

public any GETAUTHORSERVICE()


GETBIOGRAPHY

public any GETBIOGRAPHY()


GETCREATEDDATE

public any GETCREATEDDATE()


GETEMAIL

public any GETEMAIL()


GETENTRIES

public array GETENTRIES()


GETFIRSTNAME

public any GETFIRSTNAME()


GETISACTIVE

public any GETISACTIVE()


GETLASTLOGIN

public any GETLASTLOGIN()


GETLASTNAME

public any GETLASTNAME()


GETLOGGEDIN

public boolean GETLOGGEDIN()


GETNUMBEROFENTRIES

public any GETNUMBEROFENTRIES()


GETNUMBEROFPAGES

public any GETNUMBEROFPAGES()


GETPAGES

public array GETPAGES()


GETPASSWORD

public any GETPASSWORD()


GETPERMISSIONLIST

public any GETPERMISSIONLIST()


GETPERMISSIONS

public array GETPERMISSIONS()


GETPREFERENCES

public any GETPREFERENCES()


GETROLE

public any GETROLE()


GETUSERNAME

public any GETUSERNAME()


HASENTRY

public boolean HASENTRY([Entry entries])

Parameters:
entries

HASPAGE

public boolean HASPAGE([Page pages])

Parameters:
pages

HASPERMISSION

public boolean HASPERMISSION([Permission permissions])

Parameters:
permissions

HASROLE

public boolean HASROLE()


REMOVEENTRY

public boolean REMOVEENTRY(Entry entry)

Parameters:
entry

REMOVEPAGE

public boolean REMOVEPAGE(Page page)

Parameters:
page

REMOVEPERMISSION

public boolean REMOVEPERMISSION(Permission permission)

Parameters:
permission

SETAUTHORSERVICE

public void SETAUTHORSERVICE(any authorService)

Parameters:
authorService

SETBIOGRAPHY

public void SETBIOGRAPHY(any biography)

Parameters:
biography

SETCREATEDDATE

public void SETCREATEDDATE(any createdDate)

Parameters:
createdDate

SETEMAIL

public void SETEMAIL(any email)

Parameters:
email

SETENTRIES

public void SETENTRIES(array entries)

Parameters:
entries

SETFIRSTNAME

public void SETFIRSTNAME(any firstName)

Parameters:
firstName

SETISACTIVE

public void SETISACTIVE(any isActive)

Parameters:
isActive

SETLASTLOGIN

public void SETLASTLOGIN(any lastLogin)

Parameters:
lastLogin

SETLASTNAME

public void SETLASTNAME(any lastName)

Parameters:
lastName

SETLOGGEDIN

public void SETLOGGEDIN(boolean loggedIn)

Parameters:
loggedIn

SETNUMBEROFENTRIES

public void SETNUMBEROFENTRIES(any numberOfEntries)

Parameters:
numberOfEntries

SETNUMBEROFPAGES

public void SETNUMBEROFPAGES(any numberOfPages)

Parameters:
numberOfPages

SETPAGES

public void SETPAGES(array pages)

Parameters:
pages

SETPASSWORD

public void SETPASSWORD(any password)

Parameters:
password

SETPERMISSIONLIST

public void SETPERMISSIONLIST(any permissionList)

Parameters:
permissionList

SETROLE

public void SETROLE(any role)

Parameters:
role

SETUSERNAME

public void SETUSERNAME(any username)

Parameters:
username

checkPermission

public boolean checkPermission(any slug)
Check for permission

Parameters:
slug - The permission slug or list of slugs to validate the user has. If it's a list then they are ORed together

clearPermissions

public Author clearPermissions()
Clear all permissions


getAllPreferences

public struct getAllPreferences()
Get all user preferences in inflated format


getDisplayCreatedDate

public string getDisplayCreatedDate()
Get formatted createdDate


getDisplayLastLogin

public string getDisplayLastLogin()
Get formatted lastLogin


getMemento

public any getMemento()
Get a flat representation of this entry


getName

public string getName()
Retrieve full name


getPreference

public any getPreference(any name, [any defaultValue])
Get a preference, you can pass a default value if preference does not exist

Parameters:
name
defaultValue

inPermissionList

public any inPermissionList(any list)
Verify that a passed in list of perms the user can use

Parameters:
list

isLoaded

public boolean isLoaded()
is loaded?


isLoggedIn

public any isLoggedIn()
Logged in


preInsert

public void preInsert()


setPermissions

public Author setPermissions(array permissions)
Override the setPermissions

Parameters:
permissions

setPreference

public Author setPreference(any name, any value)
Set a preference in the user preferences

Parameters:
name
value

setPreferences

public Author setPreferences(any preferences)
Store a preferences structure or JSON data in the user prefernces

Parameters:
preferences - A struct of data or a JSON packet to store

ContentBox Core API 1.5.7