diff options
| author | Russ Allbery <rra@stanford.edu> | 2007-09-18 20:45:32 +0000 | 
|---|---|---|
| committer | Russ Allbery <rra@stanford.edu> | 2007-09-18 20:45:32 +0000 | 
| commit | 63064e0eed47e6932ad6917ef793e6ccde23160c (patch) | |
| tree | 0a7e06271767f6a30de827b84602178f665d4ed7 /docs | |
| parent | 4ecc4f780ca32a7641329121d13e8bf353154358 (diff) | |
Note cases where one might want to override flag_set() or flag_clear().
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/design-api | 14 | 
1 files changed, 14 insertions, 0 deletions
| diff --git a/docs/design-api b/docs/design-api index 3324620..48c5a66 100644 --- a/docs/design-api +++ b/docs/design-api @@ -45,6 +45,20 @@ Object API      administrator will want to destroy an orphaned wallet database entry      after something happened to the remote system entry. +  flag_clear(FLAG, PRINCIPAL, HOSTNAME [, DATETIME]) + +    Normally, objects won't have to override this method, but if the +    object implementation has to take special action when the unchanging +    flag is cleared, this is the place to do it.  Take whatever action is +    needed and then call the parent method to do the database work. + +  flag_set(FLAG, PRINCIPAL, HOSTNAME [, DATETIME]) + +    As with flag_set(), normally object implementations won't need to +    override this method but may want to if they have to take special +    actions when the unchanging flag is set.  Take whatever action is +    needed and then call the parent method to do the database work. +    get(PRINCIPAL, HOSTNAME [, DATETIME])      This is the one method that all object implementations must override. | 
