skinny.controller

SkinnyApiResourceActions

trait SkinnyApiResourceActions[Id] extends AnyRef

Actions for Skinny API resource.

Self Type
SkinnyApiResourceActions[Id] with SkinnyControllerBase
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SkinnyApiResourceActions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createForm: MapValidator

    Input form for creation

    Input form for creation

    Attributes
    protected
  2. abstract def createFormStrongParameters: Seq[(String, ParamType)]

    Strong parameter definitions for creation form

    Strong parameter definitions for creation form

    Attributes
    protected
  3. abstract def model: SkinnyModel[Id, _]

    SkinnyModel for this resource.

    SkinnyModel for this resource.

    Attributes
    protected
  4. abstract def resourceName: String

    Resource name in the singular.

    Resource name in the singular. This name will be used for path and validator's prefix.

    Attributes
    protected
  5. abstract def resourcesName: String

    Resource name in the plural.

    Resource name in the plural. This name will be used for path and directory name to locale template files.

    Attributes
    protected
  6. abstract def updateForm: MapValidator

    Input form for modification

    Input form for modification

    Attributes
    protected
  7. abstract def updateFormStrongParameters: Seq[(String, ParamType)]

    Strong parameter definitions for modification form

    Strong parameter definitions for modification form

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def countResources(): Long

    Attributes
    protected
  7. def createParams: Params

    Params for creation.

    Params for creation.

    Attributes
    protected
  8. def createResource()(implicit format: Format = Format.HTML): Any

    Creates new resource.

    Creates new resource.

    POST /{resources}

    format

    format

    returns

    created response if success

  9. def debugLoggingParameters(form: MapValidator, id: Option[Id] = None): Unit

    Outputs debug logging for passed parameters.

    Outputs debug logging for passed parameters.

    form

    input form

    id

    id if exists

    Attributes
    protected
  10. def debugLoggingPermittedParameters(parameters: PermittedStrongParameters, id: Option[Id] = None): Unit

    Outputs debug logging for permitted parameters.

    Outputs debug logging for permitted parameters.

    parameters

    permitted strong parameters

    id

    id if exists

    Attributes
    protected
  11. def destroyResource(id: Id)(implicit format: Format = Format.HTML): Any

    Destroys the specified resource.

    Destroys the specified resource.

    DELETE /{resources}/{id}

    id

    id

    format

    format

    returns

    result

  12. def doCreateAndReturnId(parameters: PermittedStrongParameters): Id

    Executes resource creation.

    Executes resource creation.

    parameters

    permitted parameters

    returns

    generated resource id

    Attributes
    protected
  13. def doDestroy(id: Id): Int

    Executes deletion of the specified single resource.

    Executes deletion of the specified single resource.

    id

    id

    returns

    count

    Attributes
    protected
  14. def doUpdate(id: Id, parameters: PermittedStrongParameters): Int

    Executes modification for the specified resource.

    Executes modification for the specified resource.

    id

    id

    parameters

    permitted parameters

    returns

    count

    Attributes
    protected
  15. def enablePagination: Boolean

    Attributes
    protected
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def findResource(id: Id): Option[_]

    Attributes
    protected
  20. def findResources(): List[_]

    Attributes
    protected
  21. def findResources(pageSize: Int, pageNo: Int): List[_]

    Attributes
    protected
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  24. def idName: String

    Id field name.

    Id field name.

    Attributes
    protected
  25. def idParamName: String

    Id parameter name.

    Id parameter name.

    Attributes
    protected
  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  28. final def normalizedResourcesBasePath: String

    Normalized base path.

    Normalized base path. This method should not be overridden.

    Attributes
    protected
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  31. def pageNoParamName: String

    Attributes
    protected
  32. def pageSize: Int

    Attributes
    protected
  33. def resourcesBasePath: String

    Base path.

    Base path.

    Attributes
    protected
  34. def resourcesBasePathPrefix: String

    Base path prefix.

    Base path prefix. (e.g. /admin/{resourcesName} )

    Attributes
    protected
  35. def showResource(id: Id)(implicit format: Format = Format.HTML): Any

    Show single resource.

    Show single resource.

    GET /{resources}/{id} GET /{resources}/{id}.xml GET /{resources}/{id}.json

    id

    id

    format

    format

    returns

    single resource

  36. def showResources()(implicit format: Format = Format.HTML): Any

    Shows a list of resource.

    Shows a list of resource.

    GET /{resources}/ GET /{resources}/?pageNo=1&pageSize=10 GET /{resources} GET /{resources}.xml GET /{resources}.json

    format

    format

    returns

    list of resource

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. def toString(): String

    Definition Classes
    AnyRef → Any
  39. def updateParams: Params

    Params for modification.

    Params for modification.

    Attributes
    protected
  40. def updateResource(id: Id)(implicit format: Format = Format.HTML): Any

    Updates the specified single resource.

    Updates the specified single resource.

    PUT /{resources}/{id}

    id

    id

    format

    format

    returns

    result

  41. def useRelativePathForResourcesBasePath: Boolean

    Use relative path if true.

    Use relative path if true. This is set as false by default.

    If you set this as true, routing will become simpler but /{resources}.xml or /{resources}.json don't work.

    Attributes
    protected
  42. def validation(params: Params, validations: NewValidation*)(implicit locale: Locale = currentLocale.orNull[Locale]): MapValidator

    Creates validator with prefix(resourceName).

    Creates validator with prefix(resourceName).

    params

    params

    validations

    validations

    locale

    current locale

    returns

    validator

  43. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. def xmlItemName: String

    Each resource item element name in the XML response.

    Each resource item element name in the XML response.

    Attributes
    protected
  47. def xmlRootName: String

    Root element name in the XML response.

    Root element name in the XML response.

    Attributes
    protected

Inherited from AnyRef

Inherited from Any

Ungrouped