Package org.opencastproject.search.api

Class SearchResult

java.lang.Object

org.opencastproject.search.api.SearchResult

public class SearchResult
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELETED_DATE
static final String	DUBLINCORE
static final String	INDEX_ACL
static final String	LIVE
static final String	MEDIAPACKAGE
static final String	MEDIAPACKAGE_XML
static final String	MODIFIED_DATE
static final String	ORG
static final String	REST_ACL
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
SearchResult(SearchService.IndexEntryType type, DublinCoreCatalog dc, AccessControlList acl, String orgId, MediaPackage mp, Instant modified, Instant deleted)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	dehydrate()
static Map<String,Set<String>>	dehydrateAclForIndex(AccessControlList acl)	Simplify ACL structure, so we can easily search by action.
static List<Map<String,?>>	dehydrateAclForREST(AccessControlList acl)
static Map<String,List<String>>	dehydrateDC(DublinCoreCatalog dublinCoreCatalog)
Map<String,Object>	dehydrateEpisode()
Map<String,Object>	dehydrateForIndex()
Map<String,Object>	dehydrateForREST()
Map<String,Object>	dehydrateSeries()
AccessControlList	getAcl()
Instant	getCreatedDate()
Date	getDeletionDate()
DublinCoreCatalog	getDublinCore()
String	getId()
Boolean	getLive()
MediaPackage	getMediaPackage()
Date	getModifiedDate()
String	getOrgId()
SearchService.IndexEntryType	getType()
static SearchResult	rehydrate(Map<String,Object> data)
static AccessControlList	rehydrateACL(Map<String,Object> map)
static DublinCoreCatalog	rehydrateDC(SearchService.IndexEntryType type, Map<String,Object> map)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

MEDIAPACKAGE

public static final String MEDIAPACKAGE

See Also:

• Constant Field Values

MEDIAPACKAGE_XML

public static final String MEDIAPACKAGE_XML

See Also:

• Constant Field Values

DUBLINCORE

public static final String DUBLINCORE

See Also:

• Constant Field Values

ORG

public static final String ORG

See Also:

• Constant Field Values

MODIFIED_DATE

public static final String MODIFIED_DATE

See Also:

• Constant Field Values

DELETED_DATE

public static final String DELETED_DATE

See Also:

• Constant Field Values

INDEX_ACL

public static final String INDEX_ACL

See Also:

• Constant Field Values

REST_ACL

public static final String REST_ACL

See Also:

• Constant Field Values

LIVE

public static final String LIVE

See Also:

• Constant Field Values

Constructor Details

SearchResult

public SearchResult(SearchService.IndexEntryType type,
 DublinCoreCatalog dc,
 AccessControlList acl,
 String orgId,
 MediaPackage mp,
 Instant modified,
 Instant deleted)

Method Details

getModifiedDate

public Date getModifiedDate()

getId

public String getId()

getLive

public Boolean getLive()

getDeletionDate

public Date getDeletionDate()

rehydrate

public static SearchResult rehydrate(Map<String,Object> data)
                              throws SearchException

Throws:

SearchException

dehydrateDC

public static Map<String,List<String>> dehydrateDC(DublinCoreCatalog dublinCoreCatalog)

dehydrateAclForIndex

public static Map<String,Set<String>> dehydrateAclForIndex(AccessControlList acl)

Simplify ACL structure, so we can easily search by action.

Parameters:

acl - The access control List to restructure

Returns:

Restructured ACL

dehydrateAclForREST

public static List<Map<String,?>> dehydrateAclForREST(AccessControlList acl)

rehydrateACL

public static AccessControlList rehydrateACL(Map<String,Object> map)

rehydrateDC

public static DublinCoreCatalog rehydrateDC(SearchService.IndexEntryType type,
 Map<String,Object> map)
                                     throws SearchException

Throws:

SearchException

dehydrateForIndex

public Map<String,Object> dehydrateForIndex()

dehydrateForREST

public Map<String,Object> dehydrateForREST()

dehydrate

public Map<String,Object> dehydrate()

dehydrateEpisode

public Map<String,Object> dehydrateEpisode()

dehydrateSeries

public Map<String,Object> dehydrateSeries()

getDublinCore

public DublinCoreCatalog getDublinCore()

getAcl

public AccessControlList getAcl()

getMediaPackage

public MediaPackage getMediaPackage()

getType

public SearchService.IndexEntryType getType()

getCreatedDate

public Instant getCreatedDate()

getOrgId

public String getOrgId()