ContentBox Core API 1.5.7

contentbox.model.security
Class AuthorService

WEB-INF.cftags.component
        extended by coldbox.system.orm.hibernate.BaseORMService
            extended by coldbox.system.orm.hibernate.VirtualEntityService
                extended by contentbox.model.security.AuthorService

public class AuthorService
extends coldbox.system.orm.hibernate.VirtualEntityService

******************************************************************************* 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. ******************************************************************************* Service to handle auhtor operations.


Constructor Summary
init()
          Constructor
 
Method Summary
 any GETHASHTYPE()
 any GETPERMISSIONSERVICE()
 any GETPOPULATOR()
 any GETROLESERVICE()
 void SETHASHTYPE(any hashType)
 void SETPERMISSIONSERVICE(any permissionService)
 void SETPOPULATOR(any populator)
 void SETROLESERVICE(any roleService)
 array getAllForExport()
          Get all data prepared for export
 string importFromData(any importData, [boolean override='false'], [any importLog])
          Import data from an array of structures of authors or just one structure of author
 string importFromFile(any importFile, [boolean override='false'])
          Import data from a ContentBox JSON file
 any saveAuthor([any author], [boolean passwordChange='false'], [boolean transactional='true'])
          Save an author with extra pizazz!
 any search([any searchTerm=''], [any max='0'], [any offset='0'], [any asQuery='false'], [any sortOrder='lastName'])
          Author search by name, email or username
 boolean usernameFound(any username)
          Username checks for authors
 
Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService
GETDATASOURCE, GETENTITYNAME, SETDATASOURCE, SETENTITYNAME, clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod
 
Methods inherited from class coldbox.system.orm.hibernate.BaseORMService
$delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, GETDEFAULTASQUERY, GETEVENTHANDLING, GETHQLDYNAMICCACHE, GETQUERYCACHEREGION, GETUSEQUERYCACHING, GETUSETRANSACTIONS, SETDEFAULTASQUERY, SETEVENTHANDLING, SETHQLDYNAMICCACHE, SETQUERYCACHEREGION, SETUSEQUERYCACHING, SETUSETRANSACTIONS, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getEntityGivenName, getRestrictions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, refresh, save, saveAll, sessionContains
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
Constructor

Method Detail

GETHASHTYPE

public any GETHASHTYPE()


GETPERMISSIONSERVICE

public any GETPERMISSIONSERVICE()


GETPOPULATOR

public any GETPOPULATOR()


GETROLESERVICE

public any GETROLESERVICE()


SETHASHTYPE

public void SETHASHTYPE(any hashType)

Parameters:
hashType

SETPERMISSIONSERVICE

public void SETPERMISSIONSERVICE(any permissionService)

Parameters:
permissionService

SETPOPULATOR

public void SETPOPULATOR(any populator)

Parameters:
populator

SETROLESERVICE

public void SETROLESERVICE(any roleService)

Parameters:
roleService

getAllForExport

public array getAllForExport()
Get all data prepared for export


importFromData

public string importFromData(any importData, [boolean override='false'], [any importLog])
Import data from an array of structures of authors or just one structure of author

Parameters:
importData
override
importLog

importFromFile

public string importFromFile(any importFile, [boolean override='false'])
Import data from a ContentBox JSON file. Returns the import log

Parameters:
importFile
override

saveAuthor

public any saveAuthor([any author], [boolean passwordChange='false'], [boolean transactional='true'])
Save an author with extra pizazz!

Parameters:
author
passwordChange
transactional

search

public any search([any searchTerm=''], [any max='0'], [any offset='0'], [any asQuery='false'], [any sortOrder='lastName'])
Author search by name, email or username

Parameters:
searchTerm
max
offset
asQuery
sortOrder

usernameFound

public boolean usernameFound(any username)
Username checks for authors

Parameters:
username

ContentBox Core API 1.5.7