Media Authoring
with Java API

tv.amwa.maj.union
Interface SearchByAUID

All Superinterfaces:
SearchCriteria
All Known Implementing Classes:
SearchByAUID

public interface SearchByAUID
extends SearchCriteria

Specifies a search criteria for matching mobs defined by an AUID value. The type of search represented by this criteria must be set using method setTag(SearchTag).

Author:
Richard Cartwright

Method Summary
 AUID getAUID()
          Returns the AUID that defines this search criteria.
 void setAUID(AUID identification)
          Sets the AUID that defines this search criteria.
 void setTag(SearchTag tag)
          Set the search type of this search criteria that matches items using an AUID.
 
Methods inherited from interface tv.amwa.maj.union.SearchCriteria
getSearchTag
 

Method Detail

getAUID

AUID getAUID()

Returns the AUID that defines this search criteria.

Returns:
AUID of this search criteria.

setAUID

void setAUID(AUID identification)
             throws NullPointerException

Sets the AUID that defines this search criteria.

Parameters:
identification - AUID of this search criteria.
Throws:
NullPointerException - The given identification is null.

setTag

void setTag(SearchTag tag)
            throws NullPointerException,
                   IllegalArgumentException

Set the search type of this search criteria that matches items using an AUID. The tag must be compatible with matching using AUID values. If this search is not compatible, an IllegalArgumentException is thrown. Acceptable tags are:

Parameters:
tag - Tag that identifies the kind of this search by AUID criteria.
Throws:
NullPointerException - The given search tag is null.
IllegalArgumentException - The search tag is not compatible with criteria matching using AUID values.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.