n2n Page Rocket 1 API

­Ei­Frame

Methods summary

Methods in detail

• __construct

  public __construct ( EiMask contextEiEngine , ManageState manageState )

  param

  EiMask

  ManageState

• getContextEiEngine

  public getContextEiEngine ( )

• getManageState

  ManageState public getManageState ( )

  return

  ManageState

• getN2nContext

  public getN2nContext ( )

• setParent

  public setParent ( EiFrame parent = null )

  param

  EiFrame

• getParent

  EiFrame public getParent ( )

  return

  EiFrame

• setControllerContext

  public setControllerContext ( ControllerContext controllerContext )

  param

  ControllerContext

• getControllerContext

  ControllerContext public getControllerContext ( )

  return

  ControllerContext

• setSubEiTypeExtensions

  public setSubEiTypeExtensions ( EiTypeExtension subEiTypeExtensions )

  param

  EiTypeExtension

• determineEiMask

  EiMask public determineEiMask ( EiType eiType )

  param

  EiType

  throws

  InvalidArgumentException

  return

  EiMask

• setEiRelation

  public setEiRelation ( unknown scriptId , EiRelation scriptRelation )

• hasEiRelation

  public hasEiRelation ( unknown scriptId )

• getEiRelation

  public getEiRelation ( unknown scriptId )

• setCriteriaFactory

  public setCriteriaFactory ( CriteriaFactory criteriaFactory )

  param

  CriteriaFactory

• getCriteriaConstraintCollection

  CriteriaConstraintCollection public getCriteriaConstraintCollection ( )

  return

  CriteriaConstraintCollection

• createCriteria

  public createCriteria ( unknown entityAlias , unknown ignoreConstraintTypes = 0 )

• setEiExecution

  public setEiExecution ( EiExecution eiExecution )

• getEiExecution

  public getEiExecution ( )

• hasEiExecution

  public hasEiExecution ( )

• restrictEiEntry

  EiEntry public restrictEiEntry ( EiEntry eiEntry )

  return

  EiEntry

• setOverviewDisabled

  public setOverviewDisabled ( bool overviewDisabled )

• isOverviewDisabled

  public isOverviewDisabled ( )

• setOverviewBreadcrumbLabelOverride

  public setOverviewBreadcrumbLabelOverride ( string overviewBreadcrumbLabel = null )

• getOverviewBreadcrumbLabelOverride

  public getOverviewBreadcrumbLabelOverride ( )

• getOverviewBreadcrumbLabel

  public getOverviewBreadcrumbLabel ( )

• setOverviewUrlExt

  public setOverviewUrlExt ( Url overviewUrlExt = null )

• getOverviewUrlExt

  public getOverviewUrlExt ( )

• isOverviewUrlAvailable

  public isOverviewUrlAvailable ( )

• getOverviewUrl

  public getOverviewUrl ( HttpContext httpContext , bool required = true )

• createOverviewBreadcrumb

  public createOverviewBreadcrumb ( HttpContext httpContext )

• createDetailBreadcrumb

  public createDetailBreadcrumb ( HttpContext httpContext , EiObject eiObject )

• setDetailDisabled

  public setDetailDisabled ( unknown detailDisabled )

• isDetailDisabled

  public isDetailDisabled ( )

• setDetailBreadcrumbLabelOverride

  public setDetailBreadcrumbLabelOverride ( string detailBreadcrumbLabelOverride = null )

• getDetailBreadcrumbLabelOverride

  string public getDetailBreadcrumbLabelOverride ( )

  return

  string

• getDetailBreadcrumbLabel

  string public getDetailBreadcrumbLabel ( EiObject eiObject )

  param

  EiObject

  return

  string

• setDetailUrlExt

  public setDetailUrlExt ( Url detailUrlExt )

• getDetailUrlExt

  public getDetailUrlExt ( )

• isDetailUrlAvailable

  public isDetailUrlAvailable ( EntryNavPoint entryNavPoint )

• getDetailUrl

  public getDetailUrl ( HttpContext httpContext , EntryNavPoint entryNavPoint , bool required = true )

• setCurrentUrlExt

  public setCurrentUrlExt ( Url currentUrlExt )

• getCurrentUrlExt

  public getCurrentUrlExt ( )

• getCurrentUrl

  public getCurrentUrl ( HttpContext httpContext )

• registerListener

  public registerListener ( EiFrameListener listener )

• unregisterListener

  public unregisterListener ( EiFrameListener listener )