BehaviorCommandMeta (DBFlute Runtime 1.1.0-sp2-RC1 API)

既知のサブインタフェースのリスト:

BehaviorCommand<RESULT>

既知の実装クラスのリスト:

AbstractBehaviorCommand, AbstractEntityCommand, AbstractListEntityCommand, AbstractOutsideSqlCommand, AbstractOutsideSqlSelectCommand, AbstractQueryEntityCBCommand, AbstractSelectCBCommand, BatchDeleteCommand, BatchDeleteNonstrictCommand, BatchInsertCommand, BatchUpdateCommand, BatchUpdateNonstrictCommand, DeleteEntityCommand, DeleteNonstrictEntityCommand, InsertEntityCommand, OutsideSqlCallCommand, OutsideSqlExecuteCommand, OutsideSqlSelectCursorCommand, OutsideSqlSelectListCommand, QueryDeleteCBCommand, QueryInsertCBCommand, QueryUpdateCBCommand, SelectCountCBCommand, SelectCursorCBCommand, SelectListCBCommand, SelectNextValCommand, SelectNextValSubCommand, SelectScalarCBCommand, UpdateEntityCommand, UpdateNonstrictEntityCommand
```
public interface BehaviorCommandMeta
```
The meta information interface of behavior commands.
You can get what the behavior command is.

作成者:

jflute

メソッドのサマリー

All Methods Instance Methods Abstract Methods
修飾子とタイプ	メソッドと説明
`String`	`getCommandName()` Get the name of the command, e.g. selectList, update.
`Class<?>`	`getCommandReturnType()` Get the return type of command.
`ConditionBean`	`getConditionBean()` Get the instance of condition-bean specified as argument if it exists.
`DBMeta`	`getDBMeta()` Get the DB meta instance for the table.
`String`	`getInvokePath()` Get the invoke path of behavior command lazily.
`OutsideSqlOption`	`getOutsideSqlOption()` Get the option of outside-SQL if it's outside-SQL.
`String`	`getOutsideSqlPath()` Get the path of outside-SQL if it's outside-SQL.
`Object`	`getParameterBean()` Get the parameter-bean for outside-SQL if it's outside-SQL.
`String`	`getProjectName()` Get project name of the database (DBFlute client) for the table.
`String`	`getTableDbName()` Get the DB name of table corresponding to the executed behavior.
`boolean`	`isConditionBean()` Does the command use condition-bean?
`boolean`	`isDelete()` Does the command execute delete?
`boolean`	`isInitializeOnly()` Is the command only for initialization?
`boolean`	`isInsert()` Does the command execute insert?
`boolean`	`isOutsideSql()` Does the command use outside-SQL?
`boolean`	`isProcedure()` Does the command call procedure?
`boolean`	`isSelect()` Does the command return selected records?
`boolean`	`isSelectCount()` Does the command return selected record count?
`boolean`	`isSelectCursor()` Does the command handle its cursor?
`boolean`	`isUpdate()` Does the command execute update?

- メソッドの詳細
  - getProjectName
```
String getProjectName()
```
    Get project name of the database (DBFlute client) for the table.
    
    戻り値:
    
    The project name e.g. maihamadb (NotNull)
  - getDBMeta
```
DBMeta getDBMeta()
```
    Get the DB meta instance for the table.
    
    戻り値:
    
    The (singleton) instance of DB meta for the table. (NotNull)
  - getTableDbName
```
String getTableDbName()
```
    Get the DB name of table corresponding to the executed behavior.
    
    戻り値:
    
    The DB name of table. (NotNull)
  - getCommandName
```
String getCommandName()
```
    Get the name of the command, e.g. selectList, update.
    
    戻り値:
    
    The name of the command. (NotNull)
  - getCommandReturnType
```
Class<?> getCommandReturnType()
```
    Get the return type of command. This type is not related to generic type because this is for conversion and check only.
    
    戻り値:
    
    The return type of command. (NotNull)
  - isInitializeOnly
```
boolean isInitializeOnly()
```
    Is the command only for initialization?
    
    戻り値:
    
    The determination, true or false.
  - isConditionBean
```
boolean isConditionBean()
```
    Does the command use condition-bean?
    e.g. selectList(cb), queryUpdate(entity, cb)
    
    戻り値:
    
    The determination, true or false.
  - isOutsideSql
```
boolean isOutsideSql()
```
    Does the command use outside-SQL?
    It contains procedure calls.
    e.g. outsideSql().selectList(pmb), outsideSql().execute(pmb)
    
    戻り値:
    
    The determination, true or false.
  - isProcedure
```
boolean isProcedure()
```
    Does the command call procedure?
    But if an outside-SQL containing procedure call in it, it returns false.
    e.g. outsideSql().call(pmb)
    
    戻り値:
    
    The determination, true or false.
  - isSelect
```
boolean isSelect()
```
    Does the command return selected records?
    But if it's a procedure, it returns false.
    e.g. selectList(cb), outsideSql().select(pmb)
    
    戻り値:
    
    The determination, true or false.
  - isSelectCount
```
boolean isSelectCount()
```
    Does the command return selected record count? All outside-SQL return false, even if it has 'select count(*)' in the outside-SQL. e.g. selectCount(cb)
    
    戻り値:
    
    The determination, true or false.
  - isSelectCursor
```
boolean isSelectCursor()
```
    Does the command handle its cursor? e.g. selectCursor(cb), outsideSql().cursorHandling().selectCursor(pmb)
    
    戻り値:
    
    The determination, true or false.
  - isInsert
```
boolean isInsert()
```
    Does the command execute insert?
    But if it's a procedure or an outside-SQL, it returns false.
    e.g. insert(entity), queryInsert(setupper)
    
    戻り値:
    
    The determination, true or false.
  - isUpdate
```
boolean isUpdate()
```
    Does the command execute update?
    But if it's a procedure or an outside-SQL, it returns false.
    e.g. update(entity), queryUpdate(entity, cb)
    
    戻り値:
    
    The determination, true or false.
  - isDelete
```
boolean isDelete()
```
    Does the command execute delete?
    But if it's a procedure or an outside-SQL, it returns false.
    e.g. delete(entity), queryDelete(cb)
    
    戻り値:
    
    The determination, true or false.
  - getConditionBean
```
ConditionBean getConditionBean()
```
    Get the instance of condition-bean specified as argument if it exists.
    
    戻り値:
    
    The instance of condition-bean. (NullAllowed)
  - getOutsideSqlPath
```
String getOutsideSqlPath()
```
    Get the path of outside-SQL if it's outside-SQL.
    
    戻り値:
    
    The path of outside-SQL. (NullAllowed)
  - getParameterBean
```
Object getParameterBean()
```
    Get the parameter-bean for outside-SQL if it's outside-SQL.
    
    戻り値:
    
    The parameter-bean for outside-SQL. (NullAllowed)
  - getOutsideSqlOption
```
OutsideSqlOption getOutsideSqlOption()
```
    Get the option of outside-SQL if it's outside-SQL.
    
    戻り値:
    
    The option of outside-SQL. (NullAllowed)
  - getInvokePath
```
String getInvokePath()
```
    Get the invoke path of behavior command lazily.
    Invoke path is e.g. FooAction.index():38 -> BarLogic.selectQux():127 -> ...
    To create this path needs stack trace (from exception instance) so lazily.
    
    戻り値:
    
    The display string of invoke path. (NullAllowed: e.g. before provider setup)

インタフェース BehaviorCommandMeta

メソッドのサマリー

メソッドの詳細

getProjectName

getDBMeta

getTableDbName

getCommandName

getCommandReturnType

isInitializeOnly

isConditionBean

isOutsideSql

isProcedure

isSelect

isSelectCount

isSelectCursor

isInsert

isUpdate

isDelete

getConditionBean

getOutsideSqlPath

getParameterBean

getOutsideSqlOption

getInvokePath