SkinnyApiResourceActions

Abstract Value Members

abstract def createForm: MapValidator

Input form for creation
Input form for creation

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

Strong parameter definitions for creation form
Strong parameter definitions for creation form

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

SkinnyModel for this resource.
SkinnyModel for this resource.

Attributes
protected
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
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
abstract def updateForm: MapValidator

Input form for modification
Input form for modification

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

Strong parameter definitions for modification form
Strong parameter definitions for modification form

Attributes
protected

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Attributes
protected
def createParams: Params

Params for creation.
Params for creation.

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

Creates new resource.
Creates new resource.
POST /{resources}
format
format
returns
created response if success
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
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
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
def doCreateAndReturnId(parameters: PermittedStrongParameters): Id

Executes resource creation.
Executes resource creation.
parameters
permitted parameters
returns
generated resource id

Attributes
protected
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
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
def enablePagination: Boolean

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Attributes
protected
def findResources(): List[_]

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

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def idName: String

Id field name.
Id field name.

Attributes
protected
def idParamName: String

Id parameter name.
Id parameter name.

Attributes
protected
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def normalizedResourcesBasePath: String

Normalized base path.
Normalized base path. This method should not be overridden.

Attributes
protected
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pageNoParamName: String

Attributes
protected
def pageSize: Int

Attributes
protected
def pageSizeParamName: String

Attributes
protected
def resourcesBasePath: String

Base path.
Base path.

Attributes
protected
def resourcesBasePathPrefix: String

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

Attributes
protected
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
def showResources()(implicit format: Format = Format.HTML): Any

Shows a list of resource.
Shows a list of resource.
GET /{resources}/ GET /{resources}/?page=1&size=10 GET /{resources} GET /{resources}.xml GET /{resources}.json
format
format
returns
list of resource
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def updateParams: Params

Params for modification.
Params for modification.

Attributes
protected
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
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
def validation(params: Params, validations: NewValidation*)(implicit locale: Locale = ...): MapValidator

Creates validator with prefix(resourceName).
Creates validator with prefix(resourceName).
params
params
validations
validations
locale
current locale
returns
validator
final def wait(): Unit

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

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

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

Each resource item element name in the XML response.
Each resource item element name in the XML response.

Attributes
protected
def xmlRootName: String

Root element name in the XML response.
Root element name in the XML response.

Attributes
protected

trait SkinnyApiResourceActions[Id] extends AnyRef

Abstract Value Members

abstract def createForm: MapValidator

abstract def createFormStrongParameters: Seq[(String, ParamType)]

abstract def model: SkinnyModel[Id, _]

abstract def resourceName: String

abstract def resourcesName: String

abstract def updateForm: MapValidator

abstract def updateFormStrongParameters: Seq[(String, ParamType)]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def countResources(): Long

def createParams: Params

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

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

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

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

def doCreateAndReturnId(parameters: PermittedStrongParameters): Id

def doDestroy(id: Id): Int

def doUpdate(id: Id, parameters: PermittedStrongParameters): Int

def enablePagination: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def findResource(id: Id): Option[_]

def findResources(): List[_]

def findResources(pageSize: Int, pageNo: Int): List[_]

final def getClass(): Class[_]

def hashCode(): Int

def idName: String

def idParamName: String

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def normalizedResourcesBasePath: String

final def notify(): Unit

final def notifyAll(): Unit

def pageNoParamName: String

def pageSize: Int

def pageSizeParamName: String

def resourcesBasePath: String

def resourcesBasePathPrefix: String

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

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

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

def toString(): String

def updateParams: Params

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

def useRelativePathForResourcesBasePath: Boolean

def validation(params: Params, validations: NewValidation*)(implicit locale: Locale = ...): MapValidator

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def xmlItemName: String

def xmlRootName: String

Inherited from AnyRef

Inherited from Any

Ungrouped