contentbox.model.menu

Class MenuItemService

railo-context.Component
        extended by coldbox.system.orm.hibernate.BaseORMService
            extended by coldbox.system.orm.hibernate.VirtualEntityService
                extended by contentbox.model.menu.MenuItemService
Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  

    ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp 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 menu items.

    Property Summary
    type property default serializable required
    struct providers
          The providers struct holder.

    true false
    any wirebox


    • inject = wirebox
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any getProvider(string type)
         Retrieves a registered provider.
    string getProviders()
         get: The providers struct holder.
    string getWirebox()
    any onDIComplete()
         Runs after constructor to complete DI.
    MenuItemService registerProvider(string type, string providerPath)
         Registers a provider with the service.
    any setProviders(struct providers)
         set: The providers struct holder.
    any setWirebox(any wirebox)
    MenuItemService unRegisterProvider(string type)
         Unregisters a provider with the service.
     
    Methods inherited from class coldbox.system.orm.hibernate.VirtualEntityService
    clear, convertIDValueToJavaType, convertValueToJavaType, count, countWhere, criteriaCount, criteriaQuery, deleteAll, deleteByID, deleteByQuery, deleteWhere, evict, executeQuery, exists, findAllWhere, findWhere, get, getAll, getDatasource, getEntityName, getKey, getPropertyNames, getSessionStatistics, getTableName, isSessionDirty, list, new, newCriteria, onMissingMethod, setDatasource, setEntityName
     
    Methods inherited from class coldbox.system.orm.hibernate.BaseORMService
    $delete, $deleteAll, $deleteByID, $deleteByQuery, $deleteWhere, $save, $saveAll, $transactioned, compileHQLFromDynamicMethod, createCriteriaQuery, createService, delete, evictEntity, evictQueries, findAll, findByExample, findDynamically, findIt, getDefaultAsQuery, getEntityGivenName, getEventHandling, getHQLDynamicCache, getORM, getORMEventHandler, getQueryCacheRegion, getRestrictions, getUseQueryCaching, getUseTransactions, merge, populate, populateFromJSON, populateFromQuery, populateFromXML, populateWithPrefix, refresh, save, saveAll, sessionContains, setDefaultAsQuery, setEventHandling, setHQLDynamicCache, setORM, setORMEventHandler, setQueryCacheRegion, setUseQueryCaching, setUseTransactions
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    providers

    property struct providers

    The providers struct holder

    Attributes:
    required - false
    serializable - true

    wirebox

    property any wirebox

    Attributes:
    required - false
    inject - wirebox
    serializable - true

    Method Detail

    getProvider

    public any getProvider(string type)

    Retrieves a registered provider

    Parameters:
    type - The type of provider

    getProviders

    public string getProviders()

    get: The providers struct holder


    getWirebox

    public string getWirebox()


    onDIComplete

    public any onDIComplete()

    Runs after constructor to complete DI


    registerProvider

    public MenuItemService registerProvider(string type, string providerPath)

    Registers a provider with the service

    Parameters:
    type - The type of provider
    providerPath - Logical path for getting instance of provider

    setProviders

    public any setProviders(struct providers)

    set: The providers struct holder

    Parameters:
    providers

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox

    unRegisterProvider

    public MenuItemService unRegisterProvider(string type)

    Unregisters a provider with the service

    Parameters:
    type - The type of provider